aboutsummaryrefslogtreecommitdiffstats
path: root/packages/base-contract/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-06 18:11:35 +0800
committerFabio Berger <me@fabioberger.com>2018-03-06 18:11:35 +0800
commitf014a97e9ad583f5bdcece330ce2baf4847a6661 (patch)
tree658582e6515f4334d359d62e04a66deec66cdd28 /packages/base-contract/README.md
parent5a90fece8020f9be5c0f52f6ccf65dacb824b1cd (diff)
parent5dd065410517f511b2e087dcd91839526bac95b5 (diff)
downloaddexon-sol-tools-f014a97e9ad583f5bdcece330ce2baf4847a6661.tar
dexon-sol-tools-f014a97e9ad583f5bdcece330ce2baf4847a6661.tar.gz
dexon-sol-tools-f014a97e9ad583f5bdcece330ce2baf4847a6661.tar.bz2
dexon-sol-tools-f014a97e9ad583f5bdcece330ce2baf4847a6661.tar.lz
dexon-sol-tools-f014a97e9ad583f5bdcece330ce2baf4847a6661.tar.xz
dexon-sol-tools-f014a97e9ad583f5bdcece330ce2baf4847a6661.tar.zst
dexon-sol-tools-f014a97e9ad583f5bdcece330ce2baf4847a6661.zip
Merge branch 'development' into extractDocs
* development: Also show staging 0x.js docs on development Fix source links in docs with a hack to support old and new versions of the TypeDoc JSON files remove from devDeps Remove date for now Add ethers typescript typings to 0x.js deps. The library works without this atm since another dep of 0x.js has it as a dep. But it's more robust to have it here. Add missing instructions to add external types to tsconfig.json after installing the package
Diffstat (limited to 'packages/base-contract/README.md')
-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