aboutsummaryrefslogtreecommitdiffstats
path: root/packages/utils/README.md
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2017-12-20 01:55:48 +0800
committerBrandon Millman <brandon.millman@gmail.com>2017-12-20 01:55:48 +0800
commitca2bb60877dbefc2e4ed07f2a437cfc89538e133 (patch)
treed8929107f010284dba9ff6d7ac89cee8483a0c33 /packages/utils/README.md
parent1316a2dd2a8971771f750d8a7f457212daad520b (diff)
downloaddexon-0x-contracts-ca2bb60877dbefc2e4ed07f2a437cfc89538e133.tar.gz
dexon-0x-contracts-ca2bb60877dbefc2e4ed07f2a437cfc89538e133.tar.zst
dexon-0x-contracts-ca2bb60877dbefc2e4ed07f2a437cfc89538e133.zip
Update readmes for connect, kovan-facuets, types, and utils packages
Diffstat (limited to 'packages/utils/README.md')
-rw-r--r--packages/utils/README.md50
1 files changed, 48 insertions, 2 deletions
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