aboutsummaryrefslogtreecommitdiffstats
path: root/packages/utils/README.md
diff options
context:
space:
mode:
authorBrandon Millman <brandon@0xproject.com>2017-12-20 23:06:44 +0800
committerGitHub <noreply@github.com>2017-12-20 23:06:44 +0800
commit396e3d3ec241639b459e989b79b8591088e88ca3 (patch)
tree6187b9a252e4c1e5cfa3f1c04c59ac0844f4531a /packages/utils/README.md
parente88b01ed5b5253d07eb9b51d48c895995eaec988 (diff)
parent69b81836fe3a89b4b692285bfa4da8b5af1e8840 (diff)
downloaddexon-sol-tools-396e3d3ec241639b459e989b79b8591088e88ca3.tar
dexon-sol-tools-396e3d3ec241639b459e989b79b8591088e88ca3.tar.gz
dexon-sol-tools-396e3d3ec241639b459e989b79b8591088e88ca3.tar.bz2
dexon-sol-tools-396e3d3ec241639b459e989b79b8591088e88ca3.tar.lz
dexon-sol-tools-396e3d3ec241639b459e989b79b8591088e88ca3.tar.xz
dexon-sol-tools-396e3d3ec241639b459e989b79b8591088e88ca3.tar.zst
dexon-sol-tools-396e3d3ec241639b459e989b79b8591088e88ca3.zip
Merge pull request #280 from 0xProject/feature/updateReadmes
Update readmes for connect, kovan-faucets, types, and utils packages
Diffstat (limited to 'packages/utils/README.md')
-rw-r--r--packages/utils/README.md46
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
+```