aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-09 21:10:56 +0800
committerGitHub <noreply@github.com>2018-03-09 21:10:56 +0800
commit42fce45585ee82b80cf3d6b866b2c294a7af8bf6 (patch)
tree8e3179eee1173cbd414f9e421952aa0944798c8d /packages/react-docs/README.md
parent51e4a7343993aa14bacfa04b66e5f798dfe709e2 (diff)
parent9da57daa7f9adfe0bdfd67f89c7ac8c496c8f8b7 (diff)
downloaddexon-sol-tools-42fce45585ee82b80cf3d6b866b2c294a7af8bf6.tar
dexon-sol-tools-42fce45585ee82b80cf3d6b866b2c294a7af8bf6.tar.gz
dexon-sol-tools-42fce45585ee82b80cf3d6b866b2c294a7af8bf6.tar.bz2
dexon-sol-tools-42fce45585ee82b80cf3d6b866b2c294a7af8bf6.tar.lz
dexon-sol-tools-42fce45585ee82b80cf3d6b866b2c294a7af8bf6.tar.xz
dexon-sol-tools-42fce45585ee82b80cf3d6b866b2c294a7af8bf6.tar.zst
dexon-sol-tools-42fce45585ee82b80cf3d6b866b2c294a7af8bf6.zip
Merge pull request #443 from 0xProject/moveReactDocExample
Move `react-doc` example to separate sub-package
Diffstat (limited to 'packages/react-docs/README.md')
-rw-r--r--packages/react-docs/README.md20
1 files changed, 2 insertions, 18 deletions
diff --git a/packages/react-docs/README.md b/packages/react-docs/README.md
index 7970b7a59..cad05ca67 100644
--- a/packages/react-docs/README.md
+++ b/packages/react-docs/README.md
@@ -27,11 +27,11 @@ yarn add @0xproject/react-docs
## Usage
-View the [live example](http://react-docs-example.s3-website-us-east-1.amazonaws.com/) that renders the [@0xproject/web3-wrapper](https://github.com/0xProject/0x-monorepo/tree/development/packages/web3-wrapper) Typescript package. It's source code is in the [example directory](./example).
+View the [live example](http://react-docs-example.s3-website-us-east-1.amazonaws.com/) that renders the [@0xproject/web3-wrapper](https://github.com/0xProject/0x-monorepo/tree/development/packages/web3-wrapper) Typescript package. It's source code is in the [react-docs-example](https://github.com/0xProject/0x-monorepo/tree/development/packages/react-docs-example) 0x monorepo subpackage.
This package exposes both a single `Documentation` react component that will render a docs page, as well as all of it's sub-components in case someone wants to build their own layout.
-Currently this package still has some external dependencies outside of the `Documentation` component, so please start your project off by copying the `example` directory and modifying from there.
+Currently this package still has some external dependencies outside of the `Documentation` component, so please start your project off by copying the [react-docs-example](https://github.com/0xProject/0x-monorepo/tree/development/packages/react-docs-example) directory and modifying it there. If you need changes in the [react-docs](https://github.com/0xProject/0x-monorepo/tree/development/packages/react-docs) package, fork the 0x monorepo, make the required changes and submit a PR. Until we merge it, you can have your project depend on your own custom fork.
## Future improvements
@@ -72,19 +72,3 @@ yarn build
```bash
yarn lint
```
-
-### Run Example
-
-```bash
-yarn dev
-```
-
-### Deploy Example to S3 bucket
-
-You will need to adapt the `deploy_example` command in the `package.json` to point to an S3 bucket you've created. Make sure the bucket is publicly accessible to everyone.
-
-You will also need to install the [aws-cli](https://github.com/aws/aws-cli) and configure it with your AWS credentials.
-
-```bash
-yarn deploy_example
-```