aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-03 23:18:18 +0800
committerFabio Berger <me@fabioberger.com>2018-08-03 23:18:18 +0800
commit0e82be1bdad10fda083b360aecf548d9e948ed86 (patch)
tree5f5811b9d4d491bd7d8b94632da846261d4902df /packages/react-docs/README.md
parentd85ce6ac758a9a726c298b972a7c557e01f2ab2f (diff)
downloaddexon-sol-tools-0e82be1bdad10fda083b360aecf548d9e948ed86.tar
dexon-sol-tools-0e82be1bdad10fda083b360aecf548d9e948ed86.tar.gz
dexon-sol-tools-0e82be1bdad10fda083b360aecf548d9e948ed86.tar.bz2
dexon-sol-tools-0e82be1bdad10fda083b360aecf548d9e948ed86.tar.lz
dexon-sol-tools-0e82be1bdad10fda083b360aecf548d9e948ed86.tar.xz
dexon-sol-tools-0e82be1bdad10fda083b360aecf548d9e948ed86.tar.zst
dexon-sol-tools-0e82be1bdad10fda083b360aecf548d9e948ed86.zip
Remove react-docs-example package and links to it
Diffstat (limited to 'packages/react-docs/README.md')
-rw-r--r--packages/react-docs/README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/packages/react-docs/README.md b/packages/react-docs/README.md
index c0efc4a0b..5d56207de 100644
--- a/packages/react-docs/README.md
+++ b/packages/react-docs/README.md
@@ -1,6 +1,8 @@
## @0xproject/react-docs
-A full-page React component for rendering beautiful documentation for Solidity and Typescript code generated with [TypeDoc](http://typedoc.org/) or [Doxity](https://github.com/0xproject/doxity). See a [live example](http://react-docs-example.s3-website-us-east-1.amazonaws.com/).
+#### WARNING: Alpha software. Expect things to break when trying to use.
+
+A full-page React component for rendering beautiful documentation for Solidity and Typescript code generated with [TypeDoc](http://typedoc.org/) or [Doxity](https://github.com/0xproject/doxity).
<div style="text-align: center;">
<img src="https://s3.eu-west-2.amazonaws.com/0x-wiki-images/screenshot.png" style="padding-bottom: 20px; padding-top: 20px;" width="80%" />
@@ -27,8 +29,6 @@ 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 [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 [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.