aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs
diff options
context:
space:
mode:
Diffstat (limited to 'packages/react-docs')
-rw-r--r--packages/react-docs/README.md8
-rw-r--r--packages/react-docs/package.json4
-rw-r--r--packages/react-docs/tsconfig.json2
3 files changed, 11 insertions, 3 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!
diff --git a/packages/react-docs/package.json b/packages/react-docs/package.json
index ebc445d98..0b0a52efa 100644
--- a/packages/react-docs/package.json
+++ b/packages/react-docs/package.json
@@ -35,8 +35,8 @@
"@types/lodash": "4.14.104",
"@types/material-ui": "0.18.0",
"@types/node": "^8.0.53",
- "@types/react": "^15.0.15",
- "@types/react-dom": "^0.14.23",
+ "@types/react": "^16.0.34",
+ "@types/react-dom": "^16.0.3",
"@types/react-scroll": "0.0.31",
"@types/react-tap-event-plugin": "0.0.30",
"basscss": "^8.0.3",
diff --git a/packages/react-docs/tsconfig.json b/packages/react-docs/tsconfig.json
index 9af6638a2..82f44a62c 100644
--- a/packages/react-docs/tsconfig.json
+++ b/packages/react-docs/tsconfig.json
@@ -9,5 +9,5 @@
"*": ["node_modules/@types/*", "*"]
}
},
- "include": ["./src/**/*", "../../node_modules/web3-typescript-typings/index.d.ts"]
+ "include": ["./src/**/*"]
}