diff options
Diffstat (limited to 'packages/utils')
| -rw-r--r-- | packages/utils/README.md | 46 | ||||
| -rw-r--r-- | packages/utils/package.json | 4 |
2 files changed, 46 insertions, 4 deletions
diff --git a/packages/utils/README.md b/packages/utils/README.md index 5191e0350..f56c6c4e7 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -1,10 +1,52 @@ -utils +@0xproject/utils ------ Utils to be shared across 0x projects and packages -## Install +## Installation ```bash yarn add @0xproject/utils ``` + +## Usage + +```javascript +import { + addressUtils, + bigNumberConfigs, + classUtils, + intervalUtils, + promisify, +} from '@0xproject/utils'; +``` + +## Contributing + +We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +### Install Dependencies + +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies +```bash +yarn install +``` + +### Build + +```bash +yarn build +``` + +### Lint + +```bash +yarn lint +``` diff --git a/packages/utils/package.json b/packages/utils/package.json index 8f856d0a0..729cd5f9f 100644 --- a/packages/utils/package.json +++ b/packages/utils/package.json @@ -1,6 +1,6 @@ { "name": "@0xproject/utils", - "version": "0.1.0", + "version": "0.1.1", "description": "0x TS utils", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -19,7 +19,7 @@ }, "homepage": "https://github.com/0xProject/0x.js/packages/utils/README.md", "devDependencies": { - "@0xproject/tslint-config": "^0.2.1", + "@0xproject/tslint-config": "^0.3.0", "@types/lodash": "^4.14.86", "npm-run-all": "^4.1.2", "shx": "^0.2.2", |