diff options
author | Fabio Berger <me@fabioberger.com> | 2018-03-06 23:31:55 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-03-06 23:31:55 +0800 |
commit | 0b1ba9f9971bea9003dfb30fca535c17ce62ad08 (patch) | |
tree | 69d1c42682340eb0a1f9378f48be484f1e5b8a58 /packages/react-docs/README.md | |
parent | f014a97e9ad583f5bdcece330ce2baf4847a6661 (diff) | |
download | dexon-sol-tools-0b1ba9f9971bea9003dfb30fca535c17ce62ad08.tar dexon-sol-tools-0b1ba9f9971bea9003dfb30fca535c17ce62ad08.tar.gz dexon-sol-tools-0b1ba9f9971bea9003dfb30fca535c17ce62ad08.tar.bz2 dexon-sol-tools-0b1ba9f9971bea9003dfb30fca535c17ce62ad08.tar.lz dexon-sol-tools-0b1ba9f9971bea9003dfb30fca535c17ce62ad08.tar.xz dexon-sol-tools-0b1ba9f9971bea9003dfb30fca535c17ce62ad08.tar.zst dexon-sol-tools-0b1ba9f9971bea9003dfb30fca535c17ce62ad08.zip |
Move Documentation to the `@0xproject/react-docs` package
Diffstat (limited to 'packages/react-docs/README.md')
-rw-r--r-- | packages/react-docs/README.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/packages/react-docs/README.md b/packages/react-docs/README.md new file mode 100644 index 000000000..9299eb2d4 --- /dev/null +++ b/packages/react-docs/README.md @@ -0,0 +1,47 @@ +## @0xproject/react-docs + +A full-page React component for rendering beautiful documentation generated with [TypeDoc](http://typedoc.org/) or [Doxity](https://github.com/0xproject/doxity). + +## Installation + +```bash +yarn add @0xproject/react-docs +``` + +## 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 +``` |