diff --git a/History.md b/History.md index c21eb5a2..c6320830 100644 --- a/History.md +++ b/History.md @@ -1,6 +1,7 @@ # v3.7.0 * [ADDED] Ability to Transform Header [#287](https://github.com/C2FO/fast-csv/issues/287) +* [ADDED] Example require and import to README [#301](https://github.com/C2FO/fast-csv/issues/301) # v3.6.0 diff --git a/README.md b/README.md index 4e4a4477..b646bb97 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,20 @@ Fast-csv is library for parsing and formatting csvs or any other delimited value `npm install -S fast-csv` +## Usage + +To use `fast-csv` in `javascript` you can require the module/ + +```js +const csv = require('fast-csv'); +``` + +To import with typescript + +```typescript +import * as csv from 'fast-csv'; +``` + ## Documentation * [Parsing Docs](./docs/parsing.md) @@ -55,3 +69,4 @@ MIT * Website: * Twitter: [http://twitter.com/c2fo](http://twitter.com/c2fo) - 877.465.4045 +