diff options
Diffstat (limited to 'packages/utils/README.md')
-rw-r--r-- | packages/utils/README.md | 46 |
1 files changed, 44 insertions, 2 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 +``` |