aboutsummaryrefslogtreecommitdiffstats
path: root/packages/assert
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/assert
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/assert')
-rw-r--r--packages/assert/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/packages/assert/README.md b/packages/assert/README.md
index 59ab63e91..1ea6acfb5 100644
--- a/packages/assert/README.md
+++ b/packages/assert/README.md
@@ -8,6 +8,14 @@ Standard type and schema assertions to be used across all 0x projects and packag
yarn add @0xproject/assert
```
+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
```typescript