diff options
| author | Leonid Logvinov <logvinov.leon@gmail.com> | 2017-06-05 22:57:35 +0800 |
|---|---|---|
| committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-01-10 18:24:33 +0800 |
| commit | 210e7c5579aebba354e0cd397f45c4fc37d0ce7e (patch) | |
| tree | 4ee8d1c2331733dda615db60bd07d5fb9de49594 /packages/web3-typescript-typings/README.md | |
| parent | 3fa00465420bd702eb76c0c02cab8f852e5ed3e0 (diff) | |
| download | dexon-sol-tools-210e7c5579aebba354e0cd397f45c4fc37d0ce7e.tar dexon-sol-tools-210e7c5579aebba354e0cd397f45c4fc37d0ce7e.tar.gz dexon-sol-tools-210e7c5579aebba354e0cd397f45c4fc37d0ce7e.tar.bz2 dexon-sol-tools-210e7c5579aebba354e0cd397f45c4fc37d0ce7e.tar.lz dexon-sol-tools-210e7c5579aebba354e0cd397f45c4fc37d0ce7e.tar.xz dexon-sol-tools-210e7c5579aebba354e0cd397f45c4fc37d0ce7e.tar.zst dexon-sol-tools-210e7c5579aebba354e0cd397f45c4fc37d0ce7e.zip | |
Flash out README with instructions
Diffstat (limited to 'packages/web3-typescript-typings/README.md')
| -rw-r--r-- | packages/web3-typescript-typings/README.md | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/packages/web3-typescript-typings/README.md b/packages/web3-typescript-typings/README.md index 2d4330b5b..ffe1e00fa 100644 --- a/packages/web3-typescript-typings/README.md +++ b/packages/web3-typescript-typings/README.md @@ -1,4 +1,28 @@ Web3 Typescript Type Definition ------------------------------- -There currently isn't an official [Web3](https://github.com/ethereum/web3.js/) type definition included in the [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) project. Until that happens, we will continue to improve our own type definition. If it get's close to comprehensive, we'll add it to DefinitelyTyped. +There currently isn't an official [Web3][Web3] +type definition included in the [DefinitelyTyped][DefinitelyTyped] project. +Until that happens, we will continue to improve our own type definition. +If it get's close to comprehensive, we'll add it to [DefinitelyTyped][DefinitelyTyped]. + +[Web3]: https://github.com/ethereum/web3.js/ +[DefinitelyTyped]: https://github.com/DefinitelyTyped/DefinitelyTyped + +# Installation +Using npm: +``` +npm install --save-dev web3-typescript-typings +``` +Using yarn: +``` +yarn add web3-typescript-typings -D +``` +Also don't forget to manually include `index.d.ts` within an `include` section of your `tsconfig.json` +``` +"include": [ + ... + "./node_modules/web3-typescript-typings/index.d.ts" +] +``` +And you're ready to go to a bright type-safe and distributed future!
\ No newline at end of file |