From 011bab3c80ec7b7a853e2e4b89473618f07e693d Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Mon, 5 Mar 2018 06:11:53 +0100 Subject: Add missing instructions to add external types to tsconfig.json after installing the package --- packages/subproviders/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'packages/subproviders/README.md') 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: -- cgit v1.2.3