diff --git a/CHANGELOG.md b/CHANGELOG.md index ec9c5e3..3d147e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +## [1.0.2](https://github.com/erdDEVcode/utils/compare/v1.0.1...v1.0.2) (2020-11-16) + + +### Bug Fixes + +* Error in docs ([c7f92fa](https://github.com/erdDEVcode/utils/commit/c7f92fadaf3b3c5a51efa69e6580f35c604a90b3)) + ## [1.0.1](https://github.com/erdDEVcode/utils/compare/v1.0.0...v1.0.1) (2020-11-16) diff --git a/README.md b/README.md index 35ff490..b6c1791 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,11 @@ All predefined token and network metadata are in [`tokens.json`](https://github. This data gets loaded in and exposed via the `Data` export: ```js -import Data from 'elrond-util' +import Data from 'elrond-utils' -console.log(JSON.stringify(Data.getToken('xegld'), null, 2)) +const tokenData = Data.getToken('xegld') + +console.log(JSON.stringify(tokenData, null, 2)) /* { "symbol": "XeGLD", @@ -40,6 +42,32 @@ If you are building in Typescript then there are various useful type definitions For a full list and further documentation see https://erddevcode.github.io/utils/. +## Developer guide + +To build both ESM and CommonJS output: + +```shell +yarn build +``` + +To re-build the CommonJS output on chnage: + +```shell +yarn dev +``` + +To build the docs: + +```shell +yarn build-docs +``` + +To publish a new release (this will create a tag, publish to NPM and publich the latest docs): + +```shell +yarn release +``` + ## License MIT \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 94883b8..b01853f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "elrond-utils", - "version": "1.0.1", + "version": "1.0.2", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 2b3bdd0..9c16139 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "elrond-utils", - "version": "1.0.1", + "version": "1.0.2", "description": "Utilities and data for building with Elrond.", "main": "dist/cjs/index.js", "module": "dist/esm/index.js",