Merge pull request #434 from 0xProject/addMissingReadmeInstructions

Add Missing README Instructions

11 files changed, 79 insertions, 1 deletions

diff --git a/packages/0x.js/CHANGELOG.md b/packages/0x.js/CHANGELOG.md
index f0377160b..976ae35b2 100644
--- a/packages/0x.js/CHANGELOG.md
+++ b/packages/0x.js/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v0.33.1 - _TBD, 2018_
+
+    * Add missing EthersJs typescript typings as dependency
+
 ## v0.33.0 - _March 4, 2018_
 
     * Validate and lowercase all addresses in public methods (#373)
diff --git a/packages/0x.js/README.md b/packages/0x.js/README.md
index 18c771234..2d0394726 100644
--- a/packages/0x.js/README.md
+++ b/packages/0x.js/README.md
@@ -18,6 +18,15 @@ 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**
diff --git a/packages/0x.js/package.json b/packages/0x.js/package.json
index 18bf20ee3..2196fa777 100644
--- a/packages/0x.js/package.json
+++ b/packages/0x.js/package.json
@@ -61,7 +61,6 @@
         "copyfiles": "^1.2.0",
         "coveralls": "^3.0.0",
         "dirty-chai": "^2.0.1",
-        "ethers-typescript-typings": "^0.0.2",
         "json-loader": "^0.5.4",
         "mocha": "^4.0.1",
         "npm-run-all": "^4.1.2",
@@ -93,6 +92,7 @@
         "ethereumjs-blockstream": "^2.0.6",
         "ethereumjs-util": "^5.1.1",
         "ethers-contracts": "^2.2.1",
+        "ethers-typescript-typings": "^0.0.2",
         "js-sha3": "^0.7.0",
         "lodash": "^4.17.4",
         "uuid": "^3.1.0",
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
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
diff --git a/packages/connect/README.md b/packages/connect/README.md
index 7302322e6..393ea70a0 100644
--- a/packages/connect/README.md
+++ b/packages/connect/README.md
@@ -8,6 +8,14 @@ This repository contains a Javascript library that makes it easy to interact wit
 yarn add @0xproject/connect
 ```
 
+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
 
 *   [Docs](https://0xproject.com/docs/connect)
diff --git a/packages/dev-utils/README.md b/packages/dev-utils/README.md
index 5a8e71f2f..f7e30df1e 100644
--- a/packages/dev-utils/README.md
+++ b/packages/dev-utils/README.md
@@ -7,3 +7,11 @@ Dev utils to be shared across 0x projects and packages
 ```bash
 yarn add @0xproject/dev-utils
 ```
+
+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",
+]
+```
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:
diff --git a/packages/types/README.md b/packages/types/README.md
index d2fa33c8f..5101ee544 100644
--- a/packages/types/README.md
+++ b/packages/types/README.md
@@ -8,6 +8,14 @@ Typescript types shared across 0x projects and packages
 yarn add -D @0xproject/types
 ```
 
+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
 
 ```javascript
diff --git a/packages/utils/README.md b/packages/utils/README.md
index ffb0d0190..22de85f4a 100644
--- a/packages/utils/README.md
+++ b/packages/utils/README.md
@@ -8,6 +8,14 @@ Utils to be shared across 0x projects and packages
 yarn add @0xproject/utils
 ```
 
+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
 
 ```javascript
diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md
index 7ed66ca41..0d5defb1e 100644
--- a/packages/web3-wrapper/README.md
+++ b/packages/web3-wrapper/README.md
@@ -8,6 +8,14 @@ Wrapped version of web3 with a nicer interface that is used across 0x projects a
 yarn add @0xproject/web3-wrapper
 ```
 
+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