aboutsummaryrefslogtreecommitdiffstats
path: root/packages/assert/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-12-20 22:18:15 +0800
committerFabio Berger <me@fabioberger.com>2017-12-20 22:18:15 +0800
commit972e1675f6490bc10e8d9fd64cce2f7945cd4840 (patch)
tree11bc2769c40cf38a62a5a305c0d36dc5a2baec12 /packages/assert/README.md
parent05ee36876386764c76aa0d2359ba17258152097d (diff)
parent291e2c8fa0214d35b3829d3503d7c9067b9e26db (diff)
downloaddexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar
dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.gz
dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.bz2
dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.lz
dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.xz
dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.zst
dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.zip
Merge branch 'development' of github.com:0xProject/0x.js into development
* 'development' of github.com:0xProject/0x.js: Change contributing test Fix yarn workspaces explanation Change CONTRIBUTING section Fix the headers Address feedback Write 4 README's
Diffstat (limited to 'packages/assert/README.md')
-rw-r--r--packages/assert/README.md50
1 files changed, 47 insertions, 3 deletions
diff --git a/packages/assert/README.md b/packages/assert/README.md
index b0dc9a451..052d56582 100644
--- a/packages/assert/README.md
+++ b/packages/assert/README.md
@@ -1,10 +1,54 @@
-assert
+@0xproject/assert
------
Standard type and schema assertions to be used across all 0x projects and packages
-## Install
+## Installation
```bash
-npm install @0xproject/assert --save
+yarn add @0xproject/assert
+```
+
+## Usage
+
+```typescript
+import {assert} from '@0xproject/assert';
+
+assert.isValidBaseUnitAmount('baseUnitAmount', baseUnitAmount);
+```
+
+## Contributing
+
+We strongly encourage 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
+```
+
+### Run Tests
+
+```bash
+yarn test
```