Flash out README with instructions
This commit is contained in:
parent
3fa0046542
commit
210e7c5579
@ -1,4 +1,28 @@
|
|||||||
Web3 Typescript Type Definition
|
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!
|
@ -3,11 +3,15 @@
|
|||||||
"version": "0.0.8",
|
"version": "0.0.8",
|
||||||
"description": "Typescript type definitions for web3",
|
"description": "Typescript type definitions for web3",
|
||||||
"main": "index.d.js",
|
"main": "index.d.js",
|
||||||
|
"types": "index.d.js",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/0xProject/web3-typescript-typings.git"
|
"url": "git+https://github.com/0xProject/web3-typescript-typings.git"
|
||||||
},
|
},
|
||||||
"author": "Fabio Berger",
|
"author": "Fabio Berger",
|
||||||
|
"contributors": [
|
||||||
|
"Leonid Logvinov <logvinov.leon@gmail.com>"
|
||||||
|
],
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/0xProject/web3-typescript-typings/issues"
|
"url": "https://github.com/0xProject/web3-typescript-typings/issues"
|
||||||
|
11
packages/web3-typescript-typings/yarn.lock
Normal file
11
packages/web3-typescript-typings/yarn.lock
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
||||||
|
# yarn lockfile v1
|
||||||
|
|
||||||
|
|
||||||
|
"@types/bignumber.js@^4.0.2":
|
||||||
|
version "4.0.2"
|
||||||
|
resolved "https://registry.yarnpkg.com/@types/bignumber.js/-/bignumber.js-4.0.2.tgz#22a16946c9faa9f2c9c0ad4c7c3734a3033320ae"
|
||||||
|
|
||||||
|
bignumber.js@^4.0.2:
|
||||||
|
version "4.0.2"
|
||||||
|
resolved "https://registry.yarnpkg.com/bignumber.js/-/bignumber.js-4.0.2.tgz#2d1dc37ee5968867ecea90b6da4d16e68608d21d"
|
Loading…
x
Reference in New Issue
Block a user