aboutsummaryrefslogtreecommitdiffstats
path: root/packages/subproviders/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/subproviders/README.md
parent5a90fece8020f9be5c0f52f6ccf65dacb824b1cd (diff)
parent5dd065410517f511b2e087dcd91839526bac95b5 (diff)
downloaddexon-0x-contracts-f014a97e9ad583f5bdcece330ce2baf4847a6661.tar.gz
dexon-0x-contracts-f014a97e9ad583f5bdcece330ce2baf4847a6661.tar.zst
dexon-0x-contracts-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/subproviders/README.md')
-rw-r--r--packages/subproviders/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/packages/subproviders/README.md b/packages/subproviders/README.md
index 39e4a46e7..67a6a92d2 100644
--- a/packages/subproviders/README.md
+++ b/packages/subproviders/README.md
@@ -10,6 +10,14 @@ We have written up a [Wiki](https://0xproject.com/wiki#Web3-Provider-Examples) a
yarn add @0xproject/subproviders
```
+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
Simply import the subprovider you are interested in using: