aboutsummarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntony Kellermann2018-01-20 13:11:44 -0500
committerAntony Kellermann2018-01-20 13:11:44 -0500
commite2bbb89a50dd62ef27bd539fd7a227c8757a2f23 (patch)
tree75e74e09e7a8e491f9825553859c498cb5847c21
parent98ab1159e6589104e7f9199f8520d08af6c1324e (diff)
downloadaur-e2bbb89a50dd62ef27bd539fd7a227c8757a2f23.tar.gz
Updated readme
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 2e7bed843bcd..19c2d38824fb 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
## Command line stock and cryptocurrency portfolio tracker.
-##### Information is taken from IEX, Alpha Vantage, web API.
#### How to install:
```bash
$ git clone https://github.com/aokellermann/tick.git
@@ -41,9 +40,14 @@ securities may take up to 10 seconds each. This is due to Alpha Vantage's
relatively slow API. NYSE and NASDAQ listed stocks and ETFs, as well as cryptocurrencies
should take less than one second to print each.
-Once installed, you may read the man page for more information. Prices are
-taken from IEX, Alpha Vantage, and Coinmarketcap's web APIs.
+Once installed, you may read the man page for more information.
+#### License
+MIT License
+
+Stock information is taken from IEX's free API. Mutual fund and over-the-counter information is taken from Alpha Vantage's
+free API. Cryptocurrency information is taken from Coinmarketcap's free API. Please do not abuse the APIs by repeatedly requesting
+information. Read the provided license for more information.
#### Future Ideas
* Command to get info about a security
* More robust information in "check"