aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2017-06-05 22:57:35 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2018-01-10 18:24:33 +0800
commit210e7c5579aebba354e0cd397f45c4fc37d0ce7e (patch)
tree4ee8d1c2331733dda615db60bd07d5fb9de49594
parent3fa00465420bd702eb76c0c02cab8f852e5ed3e0 (diff)
downloaddexon-sol-tools-210e7c5579aebba354e0cd397f45c4fc37d0ce7e.tar.gz
dexon-sol-tools-210e7c5579aebba354e0cd397f45c4fc37d0ce7e.tar.zst
dexon-sol-tools-210e7c5579aebba354e0cd397f45c4fc37d0ce7e.zip
Flash out README with instructions
-rw-r--r--packages/web3-typescript-typings/README.md26
-rw-r--r--packages/web3-typescript-typings/package.json4
-rw-r--r--packages/web3-typescript-typings/yarn.lock11
3 files changed, 40 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
diff --git a/packages/web3-typescript-typings/package.json b/packages/web3-typescript-typings/package.json
index 91654bffd..3836c73fc 100644
--- a/packages/web3-typescript-typings/package.json
+++ b/packages/web3-typescript-typings/package.json
@@ -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"
diff --git a/packages/web3-typescript-typings/yarn.lock b/packages/web3-typescript-typings/yarn.lock
new file mode 100644
index 000000000..528068d54
--- /dev/null
+++ b/packages/web3-typescript-typings/yarn.lock
@@ -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"