diff --git a/README.md b/README.md index ecf9dc40..bc87b895 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,28 @@ The main focus of this library is on the accuracy of calculations, but using the All indicators can be updated over time by streaming data (prices or candles) to the `update` method. Some indicators also provide `static` batch methods for further performance improvements when providing data up-front during a backtest or historical data import. +## Installation + +```bash +npm install trading-signals +``` + ## Usage +**CommonJS:** + +```ts +const {Big, SMA} = require('trading-signals'); +``` + +**ESM:** + +```ts +import {Big, SMA} from 'trading-signals'; +``` + +**Example:** + ```typescript import {Big, SMA} from 'trading-signals';