Write 4 README's

This commit is contained in:
Leonid Logvinov 2017-12-19 16:53:41 +01:00
parent b603197ae8
commit de6fe25751
No known key found for this signature in database
GPG Key ID: 0DD294BFDE8C95D4
4 changed files with 135 additions and 12 deletions

View File

@ -3,8 +3,38 @@ assert
Standard type and schema assertions to be used across all 0x projects and packages Standard type and schema assertions to be used across all 0x projects and packages
## Install ## Installation
```bash ```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`

View File

@ -1,16 +1,17 @@
json-schemas json-schemas
------------ ------
Contains 0x-related json schemas Contains 0x-related json schemas
## Install: ## Installation
```bash ```bash
npm install @0xproject/json-schemas --save yarn add @0xproject/json-schemas
``` ```
## Usage: ## Usage
```
```javascript
import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas'; import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas';
const {orderSchema} = schemas; const {orderSchema} = schemas;
@ -22,3 +23,29 @@ const order = {
const validatorResult: ValidatorResult = validator.validate(order, orderSchema); // Contains all errors const validatorResult: ValidatorResult = validator.validate(order, orderSchema); // Contains all errors
const isValid: boolean = validator.isValid(order, orderSchema); // Only returns boolean 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`

View File

@ -1,10 +1,46 @@
tslint-config tslint-config
------------- ------
Lint rules related to 0xProject for TSLint. TSLint configuration and custom linter rules used by 0xProject.
## Install: ## Installation
```bash ```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`

View File

@ -3,8 +3,38 @@ Web3 wrapper
Wrapped version of web3 with nicer interface to be used across 0x projects and packages Wrapped version of web3 with nicer interface to be used across 0x projects and packages
## Install ## Installation
```bash ```bash
yarn add @0xproject/web3-wrapper 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`