diff --git a/README.md b/README.md index 375b179..89978f1 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,27 @@ The Alpha Vantage API requires a [free API key](https://www.alphavantage.co/supp ```julia Pkg.add("AlphaVantage") ``` -and once you have obtained your API key set it as an environment variable. +and once you have obtained your API key pass it to the client as follows:. ```julia -ENV["ALPHA_VANTAGE_API_KEY"] = "YOURKEY" +using AlphaVantage +AlphaVantage.global_key!("YOURKEY") ``` +or set it as an environment variable + +```bash +export ALPHA_VANTAGE_API_KEY=YOURKEY +``` + +and check that it is set using: + +```julia +using AlphaVantage +AlphaVantage.GLOBAL[] +``` + + If you encounter a clear bug, please file a minimal reproducible example on GitHub. ## Features