aboutsummaryrefslogtreecommitdiffstats
path: root/packages/utils
diff options
context:
space:
mode:
Diffstat (limited to 'packages/utils')
-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..39b6eab46 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 the community 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.
+
+Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
+
+### 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
+```