crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Flash out README with instructions

Browse Source
This commit is contained in:
Leonid Logvinov 2017-06-05 16:57:35 +02:00
parent 3fa0046542
commit 210e7c5579
No known key found for this signature in database
GPG Key ID: 0DD294BFDE8C95D4
3 changed files with 40 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
packages/web3-typescript-typings/README.md
View File

@ -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!

4
packages/web3-typescript-typings/package.json
View File

@ -3,11 +3,15 @@
"version": "0.0.8",
"description": "Typescript type definitions for web3",
"main": "index.d.js",
"types": "index.d.js",
"repository": {
"type": "git",
"url": "git+https://github.com/0xProject/web3-typescript-typings.git"
},
"author": "Fabio Berger",
"contributors": [
"Leonid Logvinov <logvinov.leon@gmail.com>"
],
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/0xProject/web3-typescript-typings/issues"

11
packages/web3-typescript-typings/yarn.lock Normal file
View 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"