Add changelog and readme

This commit is contained in:
Fabio Berger
2018-03-03 20:29:17 +01:00
parent 8782559c33
commit bee90abbc4
2 changed files with 50 additions and 0 deletions

View File

@@ -0,0 +1,3 @@
# CHANGELOG
## vX.X.X - _TBD, 2018_

View File

@@ -0,0 +1,47 @@
## @0xproject/react-shared
Contains React components & frontend types/utils shared between 0x projects.
## Installation
```bash
yarn add @0xproject/react-shared
```
## Contributing
We strongly encourage that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
### Install Dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
```bash
yarn config set workspaces-experimental true
```
Then install dependencies
```bash
yarn install
```
### Build
```bash
yarn build
```
### Lint
```bash
yarn lint
```
### Run Tests
```bash
yarn test
```