diff --git a/README.md b/README.md index 89705bc7..a0a29c03 100644 --- a/README.md +++ b/README.md @@ -26,46 +26,6 @@ exchanges will be added in the future. > different exchange APIs allows. The lowest interval is 1s (Seconds), > and the highest is 1M (Months) -#### Basic usage - -Get USDT denominated ATOM in the spot market from Binance in `30m` -intervals, - -``` r -## get perpetual contracts on USDT denominated ATOM -spotPrice <- cryptoQuotes::getQuote( - ticker = 'ATOMUSDT', - source = 'binance', - futures = FALSE, - interval = '30m' -) -``` - -This `spotPrice` can be passed to the `chartSeries` from `quantmod` -directly to chart it with candlesticks. - -``` r -## chart the spotPrice series -## using quantmod -quantmod::chartSeries( - x = spotPrice, - theme = quantmod::chartTheme('black') -) -``` - - - -When the `spotPrice` has been charted, the indicators in `quantmod` is -directly applicable. See for example `addBBands` - -``` r -## add bollinger bands -## using quantmod -quantmod::addBBands() -``` - - - #### Installation **Stable Version** @@ -85,3 +45,18 @@ devtools::install_github( ref = 'development' ) ``` + +#### Basic usage + +Get USDT denominated ATOM in the spot market from Binance in `30m` +intervals, + +``` r +## get perpetual contracts on USDT denominated ATOM +spotPrice <- cryptoQuotes::getQuote( + ticker = 'ATOMUSDT', + source = 'binance', + futures = FALSE, + interval = '30m' +) +```