aboutsummaryrefslogtreecommitdiffstats
path: root/packages
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-04 03:29:17 +0800
committerFabio Berger <me@fabioberger.com>2018-03-04 03:29:17 +0800
commitbee90abbc47e099d66cb51c684f9f98cbdf6af3f (patch)
treec49a60799fb92b7e77a9763f5272ee8db1a18456 /packages
parent8782559c33b5b57f643c62569b83bee6cfb7e48b (diff)
downloaddexon-0x-contracts-bee90abbc47e099d66cb51c684f9f98cbdf6af3f.tar
dexon-0x-contracts-bee90abbc47e099d66cb51c684f9f98cbdf6af3f.tar.gz
dexon-0x-contracts-bee90abbc47e099d66cb51c684f9f98cbdf6af3f.tar.bz2
dexon-0x-contracts-bee90abbc47e099d66cb51c684f9f98cbdf6af3f.tar.lz
dexon-0x-contracts-bee90abbc47e099d66cb51c684f9f98cbdf6af3f.tar.xz
dexon-0x-contracts-bee90abbc47e099d66cb51c684f9f98cbdf6af3f.tar.zst
dexon-0x-contracts-bee90abbc47e099d66cb51c684f9f98cbdf6af3f.zip
Add changelog and readme
Diffstat (limited to 'packages')
-rw-r--r--packages/react-shared/CHANGELOG.md3
-rw-r--r--packages/react-shared/README.md47
2 files changed, 50 insertions, 0 deletions
diff --git a/packages/react-shared/CHANGELOG.md b/packages/react-shared/CHANGELOG.md
new file mode 100644
index 000000000..7c3ac2adf
--- /dev/null
+++ b/packages/react-shared/CHANGELOG.md
@@ -0,0 +1,3 @@
+# CHANGELOG
+
+## vX.X.X - _TBD, 2018_
diff --git a/packages/react-shared/README.md b/packages/react-shared/README.md
new file mode 100644
index 000000000..da7ff83af
--- /dev/null
+++ b/packages/react-shared/README.md
@@ -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
+```