From ca2bb60877dbefc2e4ed07f2a437cfc89538e133 Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Tue, 19 Dec 2017 12:55:48 -0500 Subject: Update readmes for connect, kovan-facuets, types, and utils packages --- packages/utils/README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-) (limited to 'packages/utils') diff --git a/packages/utils/README.md b/packages/utils/README.md index 5191e0350..c80c6baf5 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -1,10 +1,56 @@ -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 encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository. + +[CONTRIBUTING.md](../../CONTRIBUTING.md) + +### Install Dependencies + +If you don't have yarn workspaces enabled - enable them: +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies +```bash +yarn install +``` + +### Build + +```bash +yarn build +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +N/A -- cgit v1.2.3