diff --git a/packages/assert/README.md b/packages/assert/README.md index b0dc9a4511..2bcb76f50a 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` diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md index d89f57a5e0..4b4d148ed3 100644 --- a/packages/json-schemas/README.md +++ b/packages/json-schemas/README.md @@ -1,16 +1,17 @@ json-schemas ------------- +------ Contains 0x-related json schemas -## Install: +## Installation ```bash -npm install @0xproject/json-schemas --save +yarn add @0xproject/json-schemas ``` -## Usage: -``` +## Usage + +```javascript import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas'; const {orderSchema} = schemas; @@ -22,3 +23,29 @@ const order = { const validatorResult: ValidatorResult = validator.validate(order, orderSchema); // Contains all errors const isValid: boolean = validator.isValid(order, orderSchema); // Only returns boolean ``` + +## 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` diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index 38a6bce453..b435258275 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -1,10 +1,46 @@ tslint-config -------------- +------ -Lint rules related to 0xProject for TSLint. +TSLint configuration and custom linter rules used by 0xProject. -## Install: +## Installation ```bash -npm install @0xproject/tslint-config --save-dev +yarn add --dev @0xproject/tslint-config ``` + +## Usage + +```json +{ + "extends": [ + "@0xproject/tslint-config" + ] +} +``` + +## 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` diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 0df8c63338..04f2b8ca09 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -3,8 +3,38 @@ Web3 wrapper Wrapped version of web3 with nicer interface to be used across 0x projects and packages -## Install +## Installation ```bash yarn add @0xproject/web3-wrapper ``` + +## 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`