aboutsummaryrefslogtreecommitdiffstats
path: root/packages/base-contract
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-05 13:11:53 +0800
committerFabio Berger <me@fabioberger.com>2018-03-05 13:11:53 +0800
commit011bab3c80ec7b7a853e2e4b89473618f07e693d (patch)
treec796cdfff5e9659faeb3d849759674cfd4b6e96d /packages/base-contract
parent699c0c3e05d3a882c8a59fec4f035ec25cb43c9e (diff)
downloaddexon-sol-tools-011bab3c80ec7b7a853e2e4b89473618f07e693d.tar
dexon-sol-tools-011bab3c80ec7b7a853e2e4b89473618f07e693d.tar.gz
dexon-sol-tools-011bab3c80ec7b7a853e2e4b89473618f07e693d.tar.bz2
dexon-sol-tools-011bab3c80ec7b7a853e2e4b89473618f07e693d.tar.lz
dexon-sol-tools-011bab3c80ec7b7a853e2e4b89473618f07e693d.tar.xz
dexon-sol-tools-011bab3c80ec7b7a853e2e4b89473618f07e693d.tar.zst
dexon-sol-tools-011bab3c80ec7b7a853e2e4b89473618f07e693d.zip
Add missing instructions to add external types to tsconfig.json after installing the package
Diffstat (limited to 'packages/base-contract')
-rw-r--r--packages/base-contract/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/packages/base-contract/README.md b/packages/base-contract/README.md
index ff0d4d303..fa2f3da10 100644
--- a/packages/base-contract/README.md
+++ b/packages/base-contract/README.md
@@ -8,6 +8,15 @@ BaseContract to derive all auto-generated wrappers from
yarn add @0xproject/base-contract
```
+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",
+ "./node_modules/ethers-typescript-typings/index.d.ts"
+]
+```
+
## Usage
```javascript