diff options
Diffstat (limited to 'packages/assert/README.md')
-rw-r--r-- | packages/assert/README.md | 53 |
1 files changed, 49 insertions, 4 deletions
diff --git a/packages/assert/README.md b/packages/assert/README.md index b0dc9a451..59ab63e91 100644 --- a/packages/assert/README.md +++ b/packages/assert/README.md @@ -1,10 +1,55 @@ -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 ``` |