aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-shared/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-09 15:39:38 +0800
committerFabio Berger <me@fabioberger.com>2018-03-09 15:39:38 +0800
commit9699ee4eff8a6594bd862883cac35de80dfbcf56 (patch)
tree01c5a092bd0180101dcc012e3d21320d9addb073 /packages/react-shared/README.md
parentda277f5b2743c666a9a66e4fadf6678edd44fd69 (diff)
parent0eeaac1f2b5095441f7cd04bc948515d600d1f3a (diff)
downloaddexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar.gz
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar.bz2
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar.lz
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar.xz
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.tar.zst
dexon-sol-tools-9699ee4eff8a6594bd862883cac35de80dfbcf56.zip
Merge branch 'development' into addPackagePublishConfig
* development: (94 commits) Update CHANGELOG Add solc 0.4.20 and 0.4.21 Prettier sra-report README Add new packages to top level README Updated @0xproject/utils in top level package.json Publish Updated CHANGELOGs Detail tests in the README Add support for ropsten and rinkeby Fix yarn.lock Update list of packages and organize them alphabetically Fix prettier issues Add support for going back to previous hashes via the browser back button to wiki Scroll to previous hashed elements when user clicks back button Add back strict null checks to react-shared package and fix issues remove ability to have implicit dependencies and add missing deps update license remove no-implicit-this Add example & screenshot to npmignore Remove `;` to be nice to windows users ...
Diffstat (limited to 'packages/react-shared/README.md')
-rw-r--r--packages/react-shared/README.md47
1 files changed, 47 insertions, 0 deletions
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
+```