aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2017-12-19 23:53:41 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2017-12-20 21:07:50 +0800
commitde6fe257518e661b35df080ab54b1adc6819af5b (patch)
tree9af9fdad18d208ed6837630db3c9672ad1bdd591
parentb603197ae837dca86d712760f9b18f626628096a (diff)
downloaddexon-0x-contracts-de6fe257518e661b35df080ab54b1adc6819af5b.tar.gz
dexon-0x-contracts-de6fe257518e661b35df080ab54b1adc6819af5b.tar.zst
dexon-0x-contracts-de6fe257518e661b35df080ab54b1adc6819af5b.zip
Write 4 README's
-rw-r--r--packages/assert/README.md34
-rw-r--r--packages/json-schemas/README.md37
-rw-r--r--packages/tslint-config/README.md44
-rw-r--r--packages/web3-wrapper/README.md32
4 files changed, 135 insertions, 12 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`
diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md
index d89f57a5e..4b4d148ed 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 38a6bce45..b43525827 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 0df8c6333..04f2b8ca0 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`