aboutsummaryrefslogtreecommitdiffstats
path: root/packages/types/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/types/README.md')
-rw-r--r--packages/types/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/packages/types/README.md b/packages/types/README.md
index d2fa33c8f..5101ee544 100644
--- a/packages/types/README.md
+++ b/packages/types/README.md
@@ -8,6 +8,14 @@ Typescript types shared across 0x projects and packages
yarn add -D @0xproject/types
```
+If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
+
+```
+"include": [
+ "./node_modules/web3-typescript-typings/index.d.ts",
+]
+```
+
## Usage
```javascript