aboutsummarylogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAntony Kellermann2018-01-31 15:57:42 -0500
committerAntony Kellermann2018-01-31 15:57:42 -0500
commitae4dc32ef58d61a76a9591b47e0a4fe721d78fd7 (patch)
treecf2d7df6906b1d39853816d3152021e09eaaa740 /README.md
parent3fd8913733bbb57c38683fdb80aaf12d4719a734 (diff)
downloadaur-ae4dc32ef58d61a76a9591b47e0a4fe721d78fd7.tar.gz
Added support for news
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 16 insertions, 4 deletions
diff --git a/README.md b/README.md
index 19c2d38824fb..cc0c06b62cea 100644
--- a/README.md
+++ b/README.md
@@ -40,15 +40,27 @@ 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.
+To get the top three news articles on a specific stock or cryptocurrency,
+you can run
+
+```bash
+$ tick news [symbol]
+```
+
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.
+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. News information is taken from News
+API. Shortened links are provided by Google's URL Shortener 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"
-* Historical support -- 24h/7d profits \ No newline at end of file
+* Historical support -- 7d/28d profits
+* Reduce API calls
+* Find a new API to hand all stock calls (quandl?). Alpha Vantage is unreliable \ No newline at end of file