aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/README.md
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2018-03-26 19:00:56 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2018-03-27 23:47:04 +0800
commita2e4aaa9a394c359b9bf817ff154572eb33d4fb5 (patch)
treef8a034c2fcec9a83d9f83ed50dfd220b3965e33e /packages/react-docs/README.md
parent26e9696ddb004759a4a7c5f4a8901dc3255a70f9 (diff)
downloaddexon-sol-tools-a2e4aaa9a394c359b9bf817ff154572eb33d4fb5.tar
dexon-sol-tools-a2e4aaa9a394c359b9bf817ff154572eb33d4fb5.tar.gz
dexon-sol-tools-a2e4aaa9a394c359b9bf817ff154572eb33d4fb5.tar.bz2
dexon-sol-tools-a2e4aaa9a394c359b9bf817ff154572eb33d4fb5.tar.lz
dexon-sol-tools-a2e4aaa9a394c359b9bf817ff154572eb33d4fb5.tar.xz
dexon-sol-tools-a2e4aaa9a394c359b9bf817ff154572eb33d4fb5.tar.zst
dexon-sol-tools-a2e4aaa9a394c359b9bf817ff154572eb33d4fb5.zip
Add clean-state tests
Diffstat (limited to 'packages/react-docs/README.md')
-rw-r--r--packages/react-docs/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/packages/react-docs/README.md b/packages/react-docs/README.md
index cad05ca67..9be370f10 100644
--- a/packages/react-docs/README.md
+++ b/packages/react-docs/README.md
@@ -33,6 +33,14 @@ This package exposes both a single `Documentation` react component that will ren
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.
+If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
+
+```json
+"compilerOptions": {
+ "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
+}
+```
+
## Future improvements
Feel free to contribute to these improvements!