diff --git a/README.md b/README.md index c43a77f..e7fa8ab 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,33 @@ # TDAmeritrade -| **Build Status** | -|:-----------------------------------------------------------------------------------------------------------------------------:| -| [![Build Status](https://travis-ci.org/Moelf/TDAmeritrade.jl.svg?branch=master)](https://travis-ci.org/Moelf/TDAmeritrade.jl) | +| **Build Status** | **Docs** | +|:---------------------------:|---------------------------| +| [![][build-img]][build-url] | [![][docs-img]][docs-url] | +## Quick example +```julia +julia> using TDAmeritrade -**Documentation**: [![][docs-latest-img]][docs-latest-url] +julia> TD_auth() +[ Info: REFRESH_TOKEN found, refreshing ACCESS_TOKEN +[ Info: Authentication completed. -[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg -[docs-latest-url]: https://moelf.github.io/TDAmeritrade.jl/dev/ +julia> get_quotes(["AAPL", "FB"])[:AAPL][:lastPrice] +445.49 + +julia> using Dates + +julia> price_history("GE", Minute(1), Day(1))[end] +JSON3.Object{Array{UInt8,1},SubArray{UInt64,1,Array{UInt64,1},Tuple{UnitRange{Int64}},true}} with 6 entries: + :open => 6.4 + :high => 6.4 + :low => 6.39 + :close => 6.39 + :volume => 2800 + :datetime => 1596844740000 +``` + +[build-img]: https://travis-ci.com/Moelf/TDAmeritrade.jl.svg?branch=master +[build-url]: https://travis-ci.com/Moelf/TDAmeritrade.jl +[docs-img]: https://img.shields.io/badge/docs-latest-blue.svg +[docs-url]: https://moelf.github.io/TDAmeritrade.jl/dev/