Skip to content

Commit

Permalink
Update readme and add license
Browse files Browse the repository at this point in the history
Add license

Update readme
  • Loading branch information
mijdavis2 committed Jul 11, 2017
1 parent bb450c9 commit b9d2781
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 20 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2017 MJ Davis

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# upstream
# UpStream

<p>
UpStream is a stream flow calc utility designed for <a href="http://www.tu.org/"><b>Trout Unlimited</b></a>.
</p>


> **CURRENTLY IN BETA**
>
>Missing features:
> - saving reports
> - loading reports
> - exporting reports as csv files
> - loading config files
> Streamflow calc utility for Trout Unlimited

## Requirements

Expand Down Expand Up @@ -28,26 +40,15 @@ yarn run lint

## Build

`electron-packager ./ upstream --all --overwrite`

## Specs
`yarn run build`

_Just some notes on desired features_

Inputs
- startBank.tapeFt: int
- endBank.tapeFt: int
This project was generated with [electron-vue](https://github.com/SimulatedGREG/electron-vue) using [vue-cli](https://github.com/vuejs/vue-cli). Documentation about the original structure can be found [here](https://simulatedgreg.gitbooks.io/electron-vue/content/index.html).

Output
- numberOfStationOptions
- "If 14 stations, take measurements every x ft"
- "" same for 15-17+
## License

^ Click one of those options
**Software:** [MIT (c) 2017](LICENSE)

Output
- table with tapeFt set for each station

---
**Icons:**

This project was generated with [electron-vue](https://github.com/SimulatedGREG/electron-vue) using [vue-cli](https://github.com/vuejs/vue-cli). Documentation about the original structure can be found [here](https://simulatedgreg.gitbooks.io/electron-vue/content/index.html).
- <p class="source">Scroll icon made by <a href="http://www.flaticon.com/authors/daniel-bruce" title="Daniel Bruce">Daniel Bruce</a> from <a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a></p>
3 changes: 2 additions & 1 deletion src/renderer/components/LandingPage.vue
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@
</div>
</main>
<br>
<div class="source">Icons made by <a href="http://www.freepik.com" title="Freepik">Freepik</a> from <a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a></div>
<div class="source">Icons made by <a href="http://www.flaticon.com/authors/daniel-bruce" title="Daniel Bruce">Daniel Bruce</a> from <a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a></div>
<div class="source">Icons made by <a href="http://www.flaticon.com/authors/baianat" title="Baianat">Baianat</a> from <a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a></div>
</div>
</template>

Expand Down
1 change: 1 addition & 0 deletions src/renderer/components/Report/StreamflowCalculator.vue
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
totalDischarge: ''
}),
created () {
// TODO: remove mock data fallback
this.items = this.$store.getters.flowData.length > 0 ? this.$store.getters.flowData : mockData
},
computed: {
Expand Down

0 comments on commit b9d2781

Please sign in to comment.