Robot
/
Bash-Snippets
mirror of https://github.com/alexanderepstein/Bash-Snippets
2
0
Fork 0
Code Issues Releases Wiki Activity

Updating readme

This commit is contained in:
Alex Epstein 2017-06-26 20:18:07 -04:00
parent 5ebe08a4d5
commit 1f5c9e4d37
1 changed files with 53 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -1,2 +1,54 @@
<div align="center">
# Bash-Snippets
A collection of small bash scripts for heavy terminal users
##### A collection of small bash scripts for heavy terminal users
</div>
## Weather
Provides a 3 day forecast based on your ip address
![Weather Usage](https://github.com/alexanderepstein/Bash-Snippets/blob/master/weather/weather.png?raw=true)
#### To Be Added
[ ] Take in location as arguments
## Stocks
Provides information about a certain stock symbol
![Stock Usage](https://github.com/alexanderepstein/Bash-Snippets/blob/master/stocks/stocks.png?raw=true)
## Currency
Converts currency based on realtime exchange rates
![Currency Usage](https://github.com/alexanderepstein/Bash-Snippets/blob/master/currency/currency.png?raw=true)
#### To Be Added
[ ] Pass in arguments as well on top of the option to have it guide you through input
## API's Used
* To get location based on ip address: <a href="ipinfo.io">ipinfo.io</a>
* To get and print weather based on a location: <a href="wttr.in">wttr.in</a>
* To grab the stock information in JSON format: <a href="https://www.alphavantage.co">https://www.alphavantage.co</a>
* To grab the latest exchange rate between currencies: <a href="http://api.fixer.io">http://api.fixer.io</a>
## Donate
If this project helped you in any way and you feel like buying a broke college kid a cup of coffee
[![Donate](https://img.shields.io/badge/Donate-Venmo-blue.svg)](https://venmo.com/AlexanderEpstein)
[![Donate](https://img.shields.io/badge/Donate-SquareCash-green.svg)](https://cash.me/$AlexEpstein)
## License
MIT License
Copyright (c) 2017 Alex Epstein
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.