diff --git a/docs/src/index.md b/docs/src/index.md index 62a6230..5fbb456 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -3,6 +3,9 @@ Documentation for TDAmeritrade.jl ## Getting started + +* To best use this package, for example, *real-time quotes* of stocks, you have to have a [TD Ameritrade](https://tdameritrade.com/) trading account. + 1. Make an account at [TD developers](https://developer.tdameritrade.com/apis), this is different from your TD trading account 2. Make an App, make sure to use "http://localhost" as your Callback URL 3. Add the **Consumer Key** of your application to `ENV["JL_TD_CONSUMER_KEY"]` (you can also add to your environment variable via ~/.bashrc or ~/.zshrc)