aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-28 02:16:13 +0800
committerFabio Berger <me@fabioberger.com>2018-03-28 02:16:13 +0800
commit005376276098a4e6cb832eaf5b5dbc07118e1f50 (patch)
tree543a431a5fd2a17f3b3582cfb0910f8c85357ac1 /packages/react-docs/README.md
parenteb89ef79eba3d044e10b8e52e20927bb88241ac2 (diff)
parent066d13f5b7260d28b13195c4f9aed48b4ae96cc3 (diff)
downloaddexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar
dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar.gz
dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar.bz2
dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar.lz
dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar.xz
dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar.zst
dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.zip
merge developmentx
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!