Add changelog and readme
This commit is contained in:
parent
8782559c33
commit
bee90abbc4
3
packages/react-shared/CHANGELOG.md
Normal file
3
packages/react-shared/CHANGELOG.md
Normal file
@ -0,0 +1,3 @@
|
||||
# CHANGELOG
|
||||
|
||||
## vX.X.X - _TBD, 2018_
|
47
packages/react-shared/README.md
Normal file
47
packages/react-shared/README.md
Normal 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
|
||||
```
|
Loading…
x
Reference in New Issue
Block a user