Write 4 README's

This commit is contained in:
Leonid Logvinov
2017-12-19 16:53:41 +01:00
parent b603197ae8
commit de6fe25751
4 changed files with 135 additions and 12 deletions

View File

@@ -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`