Merge b445e95 into 67ea9d0

README.md

@@ -4,8 +4,7 @@
 
 # web3.js - Ethereum JavaScript API
 
-[![Gitter][gitter-image]][gitter-url] [![StackExchange][stackexchange-image]][stackexchange-url] [![NPM Package][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] [![Coverage Status][coveralls-image]][coveralls-url]
-[![Lerna][lerna-image]][lerna-url]
+[![Gitter][gitter-image]][gitter-url] [![StackExchange][stackexchange-image]][stackexchange-url] [![NPM Package Version][npm-image-version]][npm-url] [![NPM Package Downloads][npm-image-downloads]][npm-url] [![Build Status][travis-image]][travis-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Lerna][lerna-image]][lerna-url]
 
 This is the Ethereum [JavaScript API][docs]
 which connects to the [Generic JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC) spec.
@@ -163,14 +162,13 @@ The contribution guidelines are provided in [CONTRIBUTIONS](./CONTRIBUTIONS.md)
 
 [repo]: https://github.com/ethereum/web3.js
 [docs]: http://web3js.readthedocs.io/
-[npm-image]: https://img.shields.io/npm/dm/web3.svg
+[npm-image-version]: https://img.shields.io/npm/v/web3.svg
+[npm-image-downloads]: https://img.shields.io/npm/dm/web3.svg
 [npm-url]: https://npmjs.org/package/web3
 [travis-image]: https://travis-ci.org/ethereum/web3.js.svg?branch=1.x
 [travis-url]: https://travis-ci.org/ethereum/web3.js?branch=1.x
-[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg
-[deps-url]: https://david-dm.org/ethereum/web3.js/1.x
 [deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg
-[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x/#info=devDependencies
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev
 [coveralls-image]: https://coveralls.io/repos/ethereum/web3.js/badge.svg?branch=1.x
 [coveralls-url]: https://coveralls.io/r/ethereum/web3.js?branch=1.x
 [waffle-image]: https://badge.waffle.io/ethereum/web3.js.svg?label=ready&title=Ready

packages/web3-bzz/README.md

@@ -1,8 +1,11 @@
 # web3-bzz
 
-This is a sub package of [web3.js][repo]
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
+This is a sub-package of [web3.js][repo].
+
+This is the swarm package.
 
-This is the swarm package.  
 Please read the [documentation][docs] for more.
 
 ## Installation
@@ -35,7 +38,13 @@ var bzz = new Web3Bzz('http://swarm-gateways.net');
 
 ## Types
 
-All the typescript typings are placed in the types folder.
+All the TypeScript typings are placed in the `types` folder.
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
+[npm-image]: https://img.shields.io/npm/v/web3-bzz.svg
+[npm-url]: https://npmjs.org/package/web3-bzz
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-bzz
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-bzz
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-bzz
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-bzz

packages/web3-core-helpers/README.md

@@ -1,5 +1,7 @@
 # web3-core-helpers
 
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
 This is a sub package of [web3.js][repo]
 
 Helper functions used in [web3.js][repo] packages.
@@ -26,7 +28,13 @@ helpers.errors;
 
 ## Types
 
-All the typescript typings are placed in the types folder.
+All the TypeScript typings are placed in the `types` folder.
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
+[npm-image]: https://img.shields.io/npm/v/web3-core-helpers.svg
+[npm-url]: https://npmjs.org/package/web3-core-helpers
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-core-helpers
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core-helpers
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core-helpers
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core-helpers

packages/web3-core-method/README.md

@@ -1,8 +1,11 @@
 # web3-core-method
 
-This is a sub package of [web3.js][repo]
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
+This is a sub-package of [web3.js][repo].
+
+This method package is used within most [web3.js][repo] packages.
 
-The Method package used within most [web3.js][repo] packages.
 Please read the [documentation][docs] for more.
 
 ## Installation
@@ -43,7 +46,13 @@ myCoolLib.sendTransaction({...}, function(){ ... });
 
 ## Types
 
-All the typescript typings are placed in the types folder.
+All the TypeScript typings are placed in the `types` folder.
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
+[npm-image]: https://img.shields.io/npm/v/web3-core-method.svg
+[npm-url]: https://npmjs.org/package/web3-core-method
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core-method
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core-method
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core-method

packages/web3-core-promievent/README.md

@@ -1,8 +1,11 @@
 # web3-core-promievent
 
-This is a sub package of [web3.js][repo]
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
+This is a sub-package of [web3.js][repo].
+
+This is the PromiEvent package used to return a EventEmitter mixed with a Promise to allow multiple final states as well as chaining.
 
-This is the PromiEvent package is used to return a EventEmitter mixed with a Promise to allow multiple final states as well as chaining.
 Please read the [documentation][docs] for more.
 
 ## Installation
@@ -49,8 +52,11 @@ myFunc()
 .on('done', console.log);
 ```
 
-
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
-
-
+[npm-image]: https://img.shields.io/npm/v/web3-core-promievent.svg
+[npm-url]: https://npmjs.org/package/web3-core-promievent
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-core-promievent
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core-promievent
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core-promievent
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core-promievent

packages/web3-core-requestmanager/README.md

@@ -1,8 +1,11 @@
 # web3-core-requestmanager
 
-This is a sub package of [web3.js][repo]
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
+This is a sub-package of [web3.js][repo].
+
+This requestmanager package is used by most [web3.js][repo] packages.
 
-The requestmanager package is used by most [web3.js][repo] packages.
 Please read the [documentation][docs] for more.
 
 ## Installation
@@ -35,8 +38,12 @@ var Web3RequestManager = require('web3-core-requestmanager');
 var requestManager = new Web3RequestManager(new Web3WsProvider('ws://localhost:8546'));
 ```
 
-
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
-
+[npm-image]: https://img.shields.io/npm/v/web3-core-requestmanager.svg
+[npm-url]: https://npmjs.org/package/web3-core-requestmanager
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-core-requestmanager
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core-requestmanager
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core-requestmanager
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core-requestmanager
 

packages/web3-core-subscriptions/README.md

@@ -1,8 +1,11 @@
 # web3-core-subscriptions
 
-This is a sub package of [web3.js][repo]
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]tus][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
+This is a sub-package of [web3.js][repo]
+
+This subscriptions package is used within some [web3.js][repo] packages.
 
-The subscriptions package used within some [web3.js][repo] packages.
 Please read the [documentation][docs] for more.
 
 ## Installation
@@ -54,5 +57,10 @@ myCoolLib.subscribe('newBlockHeaders', function(){ ... });
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
-
+[npm-image]: https://img.shields.io/npm/v/web3-core-subscriptions.svg
+[npm-url]: https://npmjs.org/package/web3-core-subscriptions
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-core-subscriptions
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core-subscriptions
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core-subscriptions
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core-subscriptions
 

packages/web3-core/README.md

@@ -1,8 +1,11 @@
 # web3-core
 
-This is a sub package of [web3.js][repo]
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
+This is a sub-package of [web3.js][repo].
 
 The core package contains core functions for [web3.js][repo] packages.
+
 Please read the [documentation][docs] for more.
 
 ## Installation
@@ -35,12 +38,15 @@ CoolLib.extend();
 ...
 ```
 
-[docs]: http://web3js.readthedocs.io/en/1.0/
-[repo]: https://github.com/ethereum/web3.js
-
 ## Types
 
-All the typescript typings are placed in the types folder.
+All the TypeScript typings are placed in the `types` folder.
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
+[npm-image]: https://img.shields.io/npm/v/web3-core.svg
+[npm-url]: https://npmjs.org/package/web3-core
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-core
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core

packages/web3-eth-abi/README.md

@@ -1,8 +1,11 @@
 # web3-eth-abi
 
-This is a sub package of [web3.js][repo]
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
+This is a sub-package of [web3.js][repo].
+
+This is the abi package used in the `web3-eth` package.
 
-This is the abi package to be used in the `web3-eth` package.
 Please read the [documentation][docs] for more.
 
 ## Installation
@@ -36,7 +39,13 @@ Web3EthAbi.encodeFunctionSignature('myMethod(uint256,string)');
 
 ## Types
 
-All the typescript typings are placed in the types folder.
+All the TypeScript typings are placed in the `types` folder.
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
+[npm-image]: https://img.shields.io/npm/v/web3-eth-abi.svg
+[npm-url]: https://npmjs.org/package/web3-eth-abi
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-abi
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-abi
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-abi
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth-abi

packages/web3-eth-accounts/README.md

@@ -1,8 +1,11 @@
 # web3-eth-accounts
 
-This is a sub package of [web3.js][repo]
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
+This is a sub-package of [web3.js][repo].
+
+This is the accounts package used in the `web3-eth` package.
 
-This is the accounts package to be used in the `web3-eth` package.
 Please read the [documentation][docs] for more.
 
 ## Installation
@@ -43,7 +46,13 @@ account.create();
 
 ## Types
 
-All the typescript typings are placed in the types folder.
+All the TypeScript typings are placed in the `types` folder.
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
+[npm-image]: https://img.shields.io/npm/v/web3-eth-accounts.svg
+[npm-url]: https://npmjs.org/package/web3-eth-accounts
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-accounts
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-accounts
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-accounts
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth-accounts

packages/web3-eth-contract/README.md

@@ -1,8 +1,11 @@
 # web3-eth-contract
 
-This is a sub package of [web3.js][repo]
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
+This is a sub-package of [web3.js][repo].
+
+This is the contract package used in the `web3-eth` package.
 
-This is the contract package to be used in the `web3-eth` package.
 Please read the [documentation][docs] for more.
 
 ## Installation
@@ -45,7 +48,13 @@ contract.methods.somFunc().send({from: ....})
 
 ## Types
 
-All the typescript typings are placed in the types folder.
+All the TypeScript typings are placed in the `types` folder.
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
+[npm-image]: https://img.shields.io/npm/v/web3-eth-contract.svg
+[npm-url]: https://npmjs.org/package/web3-eth-contract
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-contract
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-contract
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-contract
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth-contract

packages/web3-eth-ens/README.md

@@ -1,8 +1,11 @@
 # web3-eth-ens
 
-This is a sub package of [web3.js][repo]
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
+This is a sub-package of [web3.js][repo].
 
 This is the contract package to be used in the `web3-eth` package.
+
 Please read the [documentation][docs] for more.
 
 ## Installation
@@ -37,7 +40,13 @@ ens.getAddress('ethereum.eth').then(function(result) {
 
 ## Types
 
-All the typescript typings are placed in the types folder.
+All the TypeScript typings are placed in the `types` folder.
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
+[npm-image]: https://img.shields.io/npm/v/web3-eth-ens.svg
+[npm-url]: https://npmjs.org/package/web3-eth-ens
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-ens
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-ens
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-ens
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth-ens

packages/web3-eth-iban/README.md

@@ -1,5 +1,7 @@
 # web3-eth-iban
 
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
 This is a sub package of [web3.js][repo]
 
 This is the IBAN package to be used in the `web3-eth` package.
@@ -39,7 +41,13 @@ iban.toAddress() > '0xa94f5374Fce5edBC8E2a8697C15331677e6EbF0B';
 
 ## Types
 
-All the typescript typings are placed in the types folder.
+All the TypeScript typings are placed in the `types` folder.
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
+[npm-image]: https://img.shields.io/npm/v/web3-eth-iban.svg
+[npm-url]: https://npmjs.org/package/web3-eth-iban
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-iban
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-iban
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-iban
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=web3-eth-iban

packages/web3-eth-personal/README.md

@@ -1,8 +1,11 @@
 # web3-eth-personal
 
-This is a sub package of [web3.js][repo]
+[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+
+This is a sub-package of [web3.js][repo].
+
+This is the personal package used in the `web3-eth` package.
 
-This is the personal package to be used in the `web3-eth` package.
 Please read the [documentation][docs] for more.
 
 ## Installation
@@ -35,7 +38,13 @@ var personal = new Web3EthPersonal('ws://localhost:8546');
 
 ## Types
 
-All the typescript typings are placed in the types folder.
+All the TypeScript typings are placed in the `types` folder.
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
+[npm-image]: https://img.shields.io/npm/v/web3-eth-personal.svg
+[npm-url]: https://npmjs.org/package/web3-eth-personal
+[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-personal
+[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-personal
+[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-personal
+[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth-personal