aboutsummaryrefslogtreecommitdiffstats
path: root/packages/0x.js/README.md
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2018-03-06 07:08:56 +0800
committerBrandon Millman <brandon.millman@gmail.com>2018-03-06 07:08:56 +0800
commitd171ce4fba97847a617fc4c8fd7e3b759586c933 (patch)
treec800ae90713a098cd00a418bffe516776b579baf /packages/0x.js/README.md
parent92b9dbd706768fd0edfc8f72a90f197abd8b3d66 (diff)
parent994935b5da0b15796958a32c5bab0a25b9430b5a (diff)
downloaddexon-sol-tools-d171ce4fba97847a617fc4c8fd7e3b759586c933.tar
dexon-sol-tools-d171ce4fba97847a617fc4c8fd7e3b759586c933.tar.gz
dexon-sol-tools-d171ce4fba97847a617fc4c8fd7e3b759586c933.tar.bz2
dexon-sol-tools-d171ce4fba97847a617fc4c8fd7e3b759586c933.tar.lz
dexon-sol-tools-d171ce4fba97847a617fc4c8fd7e3b759586c933.tar.xz
dexon-sol-tools-d171ce4fba97847a617fc4c8fd7e3b759586c933.tar.zst
dexon-sol-tools-d171ce4fba97847a617fc4c8fd7e3b759586c933.zip
Merge branch 'development' into feature/sra-reporter
* development: (79 commits) 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 Fix bugs in postpublish_utils.js Update @0xproject/utils in top-level package.json Changelog tweaks Publish Updated CHANGELOGS Fix typo Add PR number to changelog entry Add changelog update to subproviders package Add `numberOfAccounts` param to `LedgerSubprovider` method `getAccountsAsync` and add tests Remove unnecessary type assertion Fix comments Add comments Don't need any external packages for 0x connect docs yet Instead of adding `@0xproject/types` to tsconfig.json, let's only add it when calling TypeDoc Fix styling Make prettier ignore postpublish_utils ...
Diffstat (limited to 'packages/0x.js/README.md')
-rw-r--r--packages/0x.js/README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/packages/0x.js/README.md b/packages/0x.js/README.md
index bac4fa5d8..2d0394726 100644
--- a/packages/0x.js/README.md
+++ b/packages/0x.js/README.md
@@ -18,11 +18,20 @@ npm install 0x.js --save
import { ZeroEx } from '0x.js';
```
+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"
+]
+```
+
#### UMD:
**Install**
-Download the UMD module from our [releases page](https://github.com/0xProject/0x.js/releases) and add it to your project.
+Download the UMD module from our [releases page](https://github.com/0xProject/0x-monorepo/releases) and add it to your project.
**Import**