diff options
Diffstat (limited to 'packages/assert')
| -rw-r--r-- | packages/assert/README.md | 34 |
1 files changed, 32 insertions, 2 deletions
diff --git a/packages/assert/README.md b/packages/assert/README.md index b0dc9a451..2bcb76f50 100644 --- a/packages/assert/README.md +++ b/packages/assert/README.md @@ -3,8 +3,38 @@ 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 + +TODO - Custom documentation page is in progress. + +## 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: +`yarn config set workspaces-experimental true` + +Then install dependencies +`yarn install` + +## Build + +`yarn build` + +## Lint + +`yarn lint` + +## Run Tests + +`yarn test` |