From 8d017d38e22d1dcade99c53c65dcd75abff463f5 Mon Sep 17 00:00:00 2001 From: Ryan Ghods Date: Tue, 31 Mar 2020 15:20:44 -0700 Subject: [PATCH 1/3] Add `npm` and `deps` README badges to packages --- README.md | 7 ++----- packages/web3-bzz/README.md | 8 ++++++++ packages/web3-core-helpers/README.md | 10 +++++++++- packages/web3-core-method/README.md | 10 +++++++++- packages/web3-core-promievent/README.md | 9 ++++++++- packages/web3-core-requestmanager/README.md | 9 ++++++++- packages/web3-core-subscriptions/README.md | 9 ++++++++- packages/web3-core/README.md | 10 +++++++++- packages/web3-eth-abi/README.md | 10 +++++++++- packages/web3-eth-accounts/README.md | 8 ++++++++ packages/web3-eth-contract/README.md | 10 +++++++++- packages/web3-eth-ens/README.md | 10 +++++++++- packages/web3-eth-iban/README.md | 10 +++++++++- packages/web3-eth-personal/README.md | 10 +++++++++- packages/web3-eth/README.md | 12 ++++++++++-- packages/web3-net/README.md | 10 +++++++++- packages/web3-providers-http/README.md | 10 +++++++++- packages/web3-providers-ipc/README.md | 10 +++++++++- packages/web3-providers-ws/README.md | 10 +++++++++- packages/web3-shh/README.md | 10 +++++++++- packages/web3-utils/README.md | 10 +++++++++- packages/web3/README.md | 8 ++++++++ 22 files changed, 186 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index d2d763ec67e..f5bc1afa91a 100644 --- a/README.md +++ b/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][npm-image]][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. @@ -167,10 +166,8 @@ The contribution guidelines are provided in [CONTRIBUTIONS](./CONTRIBUTIONS.md) [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 diff --git a/packages/web3-bzz/README.md b/packages/web3-bzz/README.md index 766be66f0ff..bc8a5e978ee 100644 --- a/packages/web3-bzz/README.md +++ b/packages/web3-bzz/README.md @@ -1,5 +1,7 @@ # web3-bzz +[![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. @@ -39,3 +41,9 @@ 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/dm/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 diff --git a/packages/web3-core-helpers/README.md b/packages/web3-core-helpers/README.md index d5a251ce88c..8c644dd4f34 100644 --- a/packages/web3-core-helpers/README.md +++ b/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/dm/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 \ No newline at end of file diff --git a/packages/web3-core-method/README.md b/packages/web3-core-method/README.md index ef4a8899061..629fb94ba75 100644 --- a/packages/web3-core-method/README.md +++ b/packages/web3-core-method/README.md @@ -1,5 +1,7 @@ # web3-core-method +[![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 Method package used within most [web3.js][repo] packages. @@ -43,7 +45,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/dm/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 diff --git a/packages/web3-core-promievent/README.md b/packages/web3-core-promievent/README.md index cfdf0b6e443..3da14ad188e 100644 --- a/packages/web3-core-promievent/README.md +++ b/packages/web3-core-promievent/README.md @@ -1,5 +1,7 @@ # web3-core-promievent +[![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 is used to return a EventEmitter mixed with a Promise to allow multiple final states as well as chaining. @@ -52,5 +54,10 @@ myFunc() [docs]: http://web3js.readthedocs.io/en/1.0/ [repo]: https://github.com/ethereum/web3.js - +[npm-image]: https://img.shields.io/npm/dm/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 diff --git a/packages/web3-core-requestmanager/README.md b/packages/web3-core-requestmanager/README.md index 7e160bec5b3..a72986372b3 100644 --- a/packages/web3-core-requestmanager/README.md +++ b/packages/web3-core-requestmanager/README.md @@ -1,5 +1,7 @@ # web3-core-requestmanager +[![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 requestmanager package is used by most [web3.js][repo] packages. @@ -38,5 +40,10 @@ var requestManager = new Web3RequestManager(new Web3WsProvider('ws://localhost:8 [docs]: http://web3js.readthedocs.io/en/1.0/ [repo]: https://github.com/ethereum/web3.js - +[npm-image]: https://img.shields.io/npm/dm/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 diff --git a/packages/web3-core-subscriptions/README.md b/packages/web3-core-subscriptions/README.md index 98ae2f91ccc..2576344bcce 100644 --- a/packages/web3-core-subscriptions/README.md +++ b/packages/web3-core-subscriptions/README.md @@ -1,5 +1,7 @@ # web3-core-subscriptions +[![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] The subscriptions package used within some [web3.js][repo] packages. @@ -54,5 +56,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/dm/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 diff --git a/packages/web3-core/README.md b/packages/web3-core/README.md index 7163f00c1e5..7f3fd72ec4e 100644 --- a/packages/web3-core/README.md +++ b/packages/web3-core/README.md @@ -1,5 +1,7 @@ # web3-core +[![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. @@ -40,7 +42,13 @@ CoolLib.extend(); ## 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/dm/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 diff --git a/packages/web3-eth-abi/README.md b/packages/web3-eth-abi/README.md index 9a42822ab11..9d4bbc10781 100644 --- a/packages/web3-eth-abi/README.md +++ b/packages/web3-eth-abi/README.md @@ -1,5 +1,7 @@ # web3-eth-abi +[![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 to be used in the `web3-eth` package. @@ -36,7 +38,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/dm/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 diff --git a/packages/web3-eth-accounts/README.md b/packages/web3-eth-accounts/README.md index a0b6cf81ce9..83ca45f90da 100644 --- a/packages/web3-eth-accounts/README.md +++ b/packages/web3-eth-accounts/README.md @@ -1,5 +1,7 @@ # web3-eth-accounts +[![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 to be used in the `web3-eth` package. @@ -47,3 +49,9 @@ 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/dm/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 diff --git a/packages/web3-eth-contract/README.md b/packages/web3-eth-contract/README.md index 11608a7d16b..95625d8619f 100644 --- a/packages/web3-eth-contract/README.md +++ b/packages/web3-eth-contract/README.md @@ -1,5 +1,7 @@ # web3-eth-contract +[![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. @@ -45,7 +47,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/dm/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 diff --git a/packages/web3-eth-ens/README.md b/packages/web3-eth-ens/README.md index e5801dc789c..a83cfd3f676 100644 --- a/packages/web3-eth-ens/README.md +++ b/packages/web3-eth-ens/README.md @@ -1,5 +1,7 @@ # web3-eth-ens +[![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. @@ -37,7 +39,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/dm/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 \ No newline at end of file diff --git a/packages/web3-eth-iban/README.md b/packages/web3-eth-iban/README.md index 922e72a7052..67c2238cb40 100644 --- a/packages/web3-eth-iban/README.md +++ b/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/dm/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 diff --git a/packages/web3-eth-personal/README.md b/packages/web3-eth-personal/README.md index 2576abe9b71..530cb68ce55 100644 --- a/packages/web3-eth-personal/README.md +++ b/packages/web3-eth-personal/README.md @@ -1,5 +1,7 @@ # web3-eth-personal +[![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 to be used in the `web3-eth` package. @@ -35,7 +37,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/dm/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 diff --git a/packages/web3-eth/README.md b/packages/web3-eth/README.md index a62b62bdded..9bd973616c5 100644 --- a/packages/web3-eth/README.md +++ b/packages/web3-eth/README.md @@ -1,5 +1,7 @@ # web3-eth +[![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 Eth package to be used [web3.js][repo]. @@ -35,7 +37,13 @@ var eth = new Web3Eth('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 +[repo]: https://github.com/ethereum/web3-eth.js +[npm-image]: https://img.shields.io/npm/dm/web3-eth.svg +[npm-url]: https://npmjs.org/package/web3-eth +[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth +[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth +[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth +[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth diff --git a/packages/web3-net/README.md b/packages/web3-net/README.md index 82c3726ddde..61a584a637f 100644 --- a/packages/web3-net/README.md +++ b/packages/web3-net/README.md @@ -1,5 +1,7 @@ # web3-net +[![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 net package to be used in other web3.js packages. @@ -35,7 +37,13 @@ var net = new Web3Net('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/dm/web3-net.svg +[npm-url]: https://npmjs.org/package/web3-net +[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-net +[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-net +[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-net +[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-net diff --git a/packages/web3-providers-http/README.md b/packages/web3-providers-http/README.md index 5f684a4d1c3..024dd1f6274 100644 --- a/packages/web3-providers-http/README.md +++ b/packages/web3-providers-http/README.md @@ -1,5 +1,7 @@ # web3-providers-http +[![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 a HTTP provider for [web3.js][repo]. @@ -44,7 +46,13 @@ var provider = new Web3HttpProvider('http://localhost:8545', options); ## 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/dm/web3-providers-http.svg +[npm-url]: https://npmjs.org/package/web3-providers-http +[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-providers-http +[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-providers-http +[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-providers-http +[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-providers-http diff --git a/packages/web3-providers-ipc/README.md b/packages/web3-providers-ipc/README.md index 3ddce3577d4..5aeec7968f9 100644 --- a/packages/web3-providers-ipc/README.md +++ b/packages/web3-providers-ipc/README.md @@ -1,5 +1,7 @@ # web3-providers-ipc +[![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 a IPC provider for [web3.js][repo]. @@ -36,7 +38,13 @@ var ipc = new Web3IpcProvider('/Users/me/Library/Ethereum/geth.ipc', 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/dm/web3-providers-ipc.svg +[npm-url]: https://npmjs.org/package/web3-providers-ipc +[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-providers-ipc +[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-providers-ipc +[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-providers-ipc +[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-providers-ipc diff --git a/packages/web3-providers-ws/README.md b/packages/web3-providers-ws/README.md index 4be274764be..0b1f4990860 100644 --- a/packages/web3-providers-ws/README.md +++ b/packages/web3-providers-ws/README.md @@ -1,5 +1,7 @@ # web3-providers-ws +[![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 a websocket provider for [web3.js][repo]. @@ -39,7 +41,13 @@ var ws = new Web3WsProvider('ws://localhost:8546', options); ## 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/dm/web3-providers-ws.svg +[npm-url]: https://npmjs.org/package/web3-providers-ws +[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-providers-ws +[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-providers-ws +[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-providers-ws +[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-providers-ws diff --git a/packages/web3-shh/README.md b/packages/web3-shh/README.md index 7958b153b1a..c1963e8538d 100644 --- a/packages/web3-shh/README.md +++ b/packages/web3-shh/README.md @@ -1,5 +1,7 @@ # web3-shh +[![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 whisper v5 package. @@ -35,7 +37,13 @@ var shh = new Web3Personal('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/dm/web3-shh.svg +[npm-url]: https://npmjs.org/package/web3-shh +[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-shh +[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-shh +[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-shh +[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-shh diff --git a/packages/web3-utils/README.md b/packages/web3-utils/README.md index accc1924bbd..c75dc167d30 100644 --- a/packages/web3-utils/README.md +++ b/packages/web3-utils/README.md @@ -1,5 +1,7 @@ # web3-utils +[![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 contains useful utility functions for Dapp developers. @@ -40,7 +42,13 @@ console.log(Web3Utils); ## 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/dm/web3-utils.svg +[npm-url]: https://npmjs.org/package/web3-utils +[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-utils +[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-utils +[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-utils +[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-utils diff --git a/packages/web3/README.md b/packages/web3/README.md index 7efbf2a1860..996231bfb65 100644 --- a/packages/web3/README.md +++ b/packages/web3/README.md @@ -1,5 +1,7 @@ # web3 +[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] + This is a main package of [web3.js](https://github.com/ethereum/web3.js) Please read the main [readme](https://github.com/ethereum/web3.js) and [documentation](https://web3js.readthedocs.io) for more. @@ -18,3 +20,9 @@ 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/dm/web3.svg +[npm-url]: https://npmjs.org/package/web3 +[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 +[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3 +[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3 \ No newline at end of file From 5a3095352cffd9cadad81b07fd9783edc0dc5e04 Mon Sep 17 00:00:00 2001 From: Ryan Ghods Date: Tue, 31 Mar 2020 15:26:51 -0700 Subject: [PATCH 2/3] Show npm package version instead of downloads --- README.md | 5 +++-- packages/web3-bzz/README.md | 4 ++-- packages/web3-core-helpers/README.md | 2 +- packages/web3-core-method/README.md | 2 +- packages/web3-core-promievent/README.md | 2 +- packages/web3-core-requestmanager/README.md | 2 +- packages/web3-core-subscriptions/README.md | 2 +- packages/web3-core/README.md | 2 +- packages/web3-eth-abi/README.md | 2 +- packages/web3-eth-accounts/README.md | 2 +- packages/web3-eth-contract/README.md | 2 +- packages/web3-eth-ens/README.md | 2 +- packages/web3-eth-iban/README.md | 2 +- packages/web3-eth-personal/README.md | 2 +- packages/web3-eth/README.md | 2 +- packages/web3-net/README.md | 2 +- packages/web3-providers-ipc/README.md | 2 +- packages/web3-providers-ws/README.md | 2 +- packages/web3-shh/README.md | 2 +- packages/web3-utils/README.md | 2 +- packages/web3/README.md | 4 ++-- 21 files changed, 25 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index f5bc1afa91a..240beed2e6a 100644 --- a/README.md +++ b/README.md @@ -4,7 +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] [![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. @@ -162,7 +162,8 @@ 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 diff --git a/packages/web3-bzz/README.md b/packages/web3-bzz/README.md index bc8a5e978ee..54f00203a4a 100644 --- a/packages/web3-bzz/README.md +++ b/packages/web3-bzz/README.md @@ -37,11 +37,11 @@ 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/dm/web3-bzz.svg +[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 diff --git a/packages/web3-core-helpers/README.md b/packages/web3-core-helpers/README.md index 8c644dd4f34..bd45b91af3d 100644 --- a/packages/web3-core-helpers/README.md +++ b/packages/web3-core-helpers/README.md @@ -32,7 +32,7 @@ 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/dm/web3-core-helpers.svg +[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 diff --git a/packages/web3-core-method/README.md b/packages/web3-core-method/README.md index 629fb94ba75..394382bad4b 100644 --- a/packages/web3-core-method/README.md +++ b/packages/web3-core-method/README.md @@ -49,7 +49,7 @@ 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/dm/web3-core-method.svg +[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 diff --git a/packages/web3-core-promievent/README.md b/packages/web3-core-promievent/README.md index 3da14ad188e..cca27146322 100644 --- a/packages/web3-core-promievent/README.md +++ b/packages/web3-core-promievent/README.md @@ -54,7 +54,7 @@ myFunc() [docs]: http://web3js.readthedocs.io/en/1.0/ [repo]: https://github.com/ethereum/web3.js -[npm-image]: https://img.shields.io/npm/dm/web3-core-promievent.svg +[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 diff --git a/packages/web3-core-requestmanager/README.md b/packages/web3-core-requestmanager/README.md index a72986372b3..d1f86b0434c 100644 --- a/packages/web3-core-requestmanager/README.md +++ b/packages/web3-core-requestmanager/README.md @@ -40,7 +40,7 @@ var requestManager = new Web3RequestManager(new Web3WsProvider('ws://localhost:8 [docs]: http://web3js.readthedocs.io/en/1.0/ [repo]: https://github.com/ethereum/web3.js -[npm-image]: https://img.shields.io/npm/dm/web3-core-requestmanager.svg +[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 diff --git a/packages/web3-core-subscriptions/README.md b/packages/web3-core-subscriptions/README.md index 2576344bcce..9122bff2e05 100644 --- a/packages/web3-core-subscriptions/README.md +++ b/packages/web3-core-subscriptions/README.md @@ -56,7 +56,7 @@ 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/dm/web3-core-subscriptions.svg +[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 diff --git a/packages/web3-core/README.md b/packages/web3-core/README.md index 7f3fd72ec4e..0ff64855d59 100644 --- a/packages/web3-core/README.md +++ b/packages/web3-core/README.md @@ -46,7 +46,7 @@ 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/dm/web3-core.svg +[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 diff --git a/packages/web3-eth-abi/README.md b/packages/web3-eth-abi/README.md index 9d4bbc10781..396278d24f6 100644 --- a/packages/web3-eth-abi/README.md +++ b/packages/web3-eth-abi/README.md @@ -42,7 +42,7 @@ 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/dm/web3-eth-abi.svg +[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 diff --git a/packages/web3-eth-accounts/README.md b/packages/web3-eth-accounts/README.md index 83ca45f90da..fa218aa4f9e 100644 --- a/packages/web3-eth-accounts/README.md +++ b/packages/web3-eth-accounts/README.md @@ -49,7 +49,7 @@ 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/dm/web3-eth-accounts.svg +[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 diff --git a/packages/web3-eth-contract/README.md b/packages/web3-eth-contract/README.md index 95625d8619f..8b17526d497 100644 --- a/packages/web3-eth-contract/README.md +++ b/packages/web3-eth-contract/README.md @@ -51,7 +51,7 @@ 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/dm/web3-eth-contract.svg +[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 diff --git a/packages/web3-eth-ens/README.md b/packages/web3-eth-ens/README.md index a83cfd3f676..3da086485a6 100644 --- a/packages/web3-eth-ens/README.md +++ b/packages/web3-eth-ens/README.md @@ -43,7 +43,7 @@ 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/dm/web3-eth-ens.svg +[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 diff --git a/packages/web3-eth-iban/README.md b/packages/web3-eth-iban/README.md index 67c2238cb40..cd81d66d0ae 100644 --- a/packages/web3-eth-iban/README.md +++ b/packages/web3-eth-iban/README.md @@ -45,7 +45,7 @@ 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/dm/web3-eth-iban.svg +[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 diff --git a/packages/web3-eth-personal/README.md b/packages/web3-eth-personal/README.md index 530cb68ce55..3ae82148f8a 100644 --- a/packages/web3-eth-personal/README.md +++ b/packages/web3-eth-personal/README.md @@ -41,7 +41,7 @@ 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/dm/web3-eth-personal.svg +[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 diff --git a/packages/web3-eth/README.md b/packages/web3-eth/README.md index 9bd973616c5..4a42994e287 100644 --- a/packages/web3-eth/README.md +++ b/packages/web3-eth/README.md @@ -41,7 +41,7 @@ All the TypeScript typings are placed in the `types` folder. [docs]: http://web3js.readthedocs.io/en/1.0/ [repo]: https://github.com/ethereum/web3-eth.js -[npm-image]: https://img.shields.io/npm/dm/web3-eth.svg +[npm-image]: https://img.shields.io/npm/v/web3-eth.svg [npm-url]: https://npmjs.org/package/web3-eth [deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth [deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth diff --git a/packages/web3-net/README.md b/packages/web3-net/README.md index 61a584a637f..93cfccc9288 100644 --- a/packages/web3-net/README.md +++ b/packages/web3-net/README.md @@ -41,7 +41,7 @@ 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/dm/web3-net.svg +[npm-image]: https://img.shields.io/npm/v/web3-net.svg [npm-url]: https://npmjs.org/package/web3-net [deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-net [deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-net diff --git a/packages/web3-providers-ipc/README.md b/packages/web3-providers-ipc/README.md index 5aeec7968f9..7413cb6be05 100644 --- a/packages/web3-providers-ipc/README.md +++ b/packages/web3-providers-ipc/README.md @@ -42,7 +42,7 @@ 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/dm/web3-providers-ipc.svg +[npm-image]: https://img.shields.io/npm/v/web3-providers-ipc.svg [npm-url]: https://npmjs.org/package/web3-providers-ipc [deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-providers-ipc [deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-providers-ipc diff --git a/packages/web3-providers-ws/README.md b/packages/web3-providers-ws/README.md index 0b1f4990860..5fe057688cc 100644 --- a/packages/web3-providers-ws/README.md +++ b/packages/web3-providers-ws/README.md @@ -45,7 +45,7 @@ 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/dm/web3-providers-ws.svg +[npm-image]: https://img.shields.io/npm/v/web3-providers-ws.svg [npm-url]: https://npmjs.org/package/web3-providers-ws [deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-providers-ws [deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-providers-ws diff --git a/packages/web3-shh/README.md b/packages/web3-shh/README.md index c1963e8538d..e1289756e79 100644 --- a/packages/web3-shh/README.md +++ b/packages/web3-shh/README.md @@ -41,7 +41,7 @@ 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/dm/web3-shh.svg +[npm-image]: https://img.shields.io/npm/v/web3-shh.svg [npm-url]: https://npmjs.org/package/web3-shh [deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-shh [deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-shh diff --git a/packages/web3-utils/README.md b/packages/web3-utils/README.md index c75dc167d30..e5d06bf6785 100644 --- a/packages/web3-utils/README.md +++ b/packages/web3-utils/README.md @@ -46,7 +46,7 @@ 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/dm/web3-utils.svg +[npm-image]: https://img.shields.io/npm/v/web3-utils.svg [npm-url]: https://npmjs.org/package/web3-utils [deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-utils [deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-utils diff --git a/packages/web3/README.md b/packages/web3/README.md index 996231bfb65..0e7b03f2cae 100644 --- a/packages/web3/README.md +++ b/packages/web3/README.md @@ -16,11 +16,11 @@ npm install web3 ## 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/dm/web3.svg +[npm-image]: https://img.shields.io/npm/v/web3.svg [npm-url]: https://npmjs.org/package/web3 [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 From b445e95133f5ac9da0c74f9dd71d851a14b81423 Mon Sep 17 00:00:00 2001 From: Ryan Ghods Date: Tue, 31 Mar 2020 15:40:44 -0700 Subject: [PATCH 3/3] better sentence grammar --- packages/web3-bzz/README.md | 5 +++-- packages/web3-core-method/README.md | 5 +++-- packages/web3-core-promievent/README.md | 9 ++++----- packages/web3-core-requestmanager/README.md | 6 +++--- packages/web3-core-subscriptions/README.md | 5 +++-- packages/web3-core/README.md | 6 ++---- packages/web3-eth-abi/README.md | 5 +++-- packages/web3-eth-accounts/README.md | 7 ++++--- packages/web3-eth-contract/README.md | 5 +++-- packages/web3-eth-ens/README.md | 3 ++- packages/web3-eth-personal/README.md | 5 +++-- packages/web3-eth/README.md | 5 +++-- packages/web3-net/README.md | 5 +++-- packages/web3-providers-http/README.md | 5 +++-- packages/web3-providers-ipc/README.md | 5 +++-- packages/web3-providers-ws/README.md | 3 ++- packages/web3-utils/README.md | 5 +++-- packages/web3/README.md | 5 +++-- 18 files changed, 53 insertions(+), 41 deletions(-) diff --git a/packages/web3-bzz/README.md b/packages/web3-bzz/README.md index 54f00203a4a..5046cec5989 100644 --- a/packages/web3-bzz/README.md +++ b/packages/web3-bzz/README.md @@ -2,9 +2,10 @@ [![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 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 diff --git a/packages/web3-core-method/README.md b/packages/web3-core-method/README.md index 394382bad4b..f00c5cb1595 100644 --- a/packages/web3-core-method/README.md +++ b/packages/web3-core-method/README.md @@ -2,9 +2,10 @@ [![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 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 diff --git a/packages/web3-core-promievent/README.md b/packages/web3-core-promievent/README.md index cca27146322..c01027f37e9 100644 --- a/packages/web3-core-promievent/README.md +++ b/packages/web3-core-promievent/README.md @@ -2,9 +2,10 @@ [![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 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 @@ -51,7 +52,6 @@ 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 @@ -59,5 +59,4 @@ myFunc() [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 - +[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core-promievent \ No newline at end of file diff --git a/packages/web3-core-requestmanager/README.md b/packages/web3-core-requestmanager/README.md index d1f86b0434c..ea703d94e79 100644 --- a/packages/web3-core-requestmanager/README.md +++ b/packages/web3-core-requestmanager/README.md @@ -2,9 +2,10 @@ [![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 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 @@ -37,7 +38,6 @@ 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 diff --git a/packages/web3-core-subscriptions/README.md b/packages/web3-core-subscriptions/README.md index 9122bff2e05..1b6ea13b151 100644 --- a/packages/web3-core-subscriptions/README.md +++ b/packages/web3-core-subscriptions/README.md @@ -2,9 +2,10 @@ [![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 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 diff --git a/packages/web3-core/README.md b/packages/web3-core/README.md index 0ff64855d59..cb495791030 100644 --- a/packages/web3-core/README.md +++ b/packages/web3-core/README.md @@ -2,9 +2,10 @@ [![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 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 @@ -37,9 +38,6 @@ 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. diff --git a/packages/web3-eth-abi/README.md b/packages/web3-eth-abi/README.md index 396278d24f6..4207ee97880 100644 --- a/packages/web3-eth-abi/README.md +++ b/packages/web3-eth-abi/README.md @@ -2,9 +2,10 @@ [![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 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 diff --git a/packages/web3-eth-accounts/README.md b/packages/web3-eth-accounts/README.md index fa218aa4f9e..16e6a26e945 100644 --- a/packages/web3-eth-accounts/README.md +++ b/packages/web3-eth-accounts/README.md @@ -2,9 +2,10 @@ [![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 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 @@ -45,7 +46,7 @@ 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 diff --git a/packages/web3-eth-contract/README.md b/packages/web3-eth-contract/README.md index 8b17526d497..97e243e0c1f 100644 --- a/packages/web3-eth-contract/README.md +++ b/packages/web3-eth-contract/README.md @@ -2,9 +2,10 @@ [![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 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 diff --git a/packages/web3-eth-ens/README.md b/packages/web3-eth-ens/README.md index 3da086485a6..8e76e26e4f6 100644 --- a/packages/web3-eth-ens/README.md +++ b/packages/web3-eth-ens/README.md @@ -2,9 +2,10 @@ [![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 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 diff --git a/packages/web3-eth-personal/README.md b/packages/web3-eth-personal/README.md index 3ae82148f8a..dcb03d8c955 100644 --- a/packages/web3-eth-personal/README.md +++ b/packages/web3-eth-personal/README.md @@ -2,9 +2,10 @@ [![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 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 diff --git a/packages/web3-eth/README.md b/packages/web3-eth/README.md index 4a42994e287..0436c26cbfb 100644 --- a/packages/web3-eth/README.md +++ b/packages/web3-eth/README.md @@ -2,9 +2,10 @@ [![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 a sub-package of [web3.js][repo]. + +This Eth package is used within some [web3.js][repo] package. -This is the Eth package to be used [web3.js][repo]. Please read the [documentation][docs] for more. ## Installation diff --git a/packages/web3-net/README.md b/packages/web3-net/README.md index 93cfccc9288..181446924da 100644 --- a/packages/web3-net/README.md +++ b/packages/web3-net/README.md @@ -2,9 +2,10 @@ [![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 a sub-package of [web3.js][repo]. + +This is the net package used in other [web3.js][repo] packages. -This is the net package to be used in other web3.js packages. Please read the [documentation][docs] for more. ## Installation diff --git a/packages/web3-providers-http/README.md b/packages/web3-providers-http/README.md index 024dd1f6274..090450f46b3 100644 --- a/packages/web3-providers-http/README.md +++ b/packages/web3-providers-http/README.md @@ -2,9 +2,10 @@ [![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 a sub-package of [web3.js][repo]. + +This is a HTTP provider for [web3.js][repo]. -This is a HTTP provider for [web3.js][repo]. Please read the [documentation][docs] for more. ## Installation diff --git a/packages/web3-providers-ipc/README.md b/packages/web3-providers-ipc/README.md index 7413cb6be05..050597d5622 100644 --- a/packages/web3-providers-ipc/README.md +++ b/packages/web3-providers-ipc/README.md @@ -2,9 +2,10 @@ [![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 a sub-package of [web3.js][repo]. + +This is a IPC provider for [web3.js][repo]. -This is a IPC provider for [web3.js][repo]. Please read the [documentation][docs] for more. ## Installation diff --git a/packages/web3-providers-ws/README.md b/packages/web3-providers-ws/README.md index 5fe057688cc..2dac56e5068 100644 --- a/packages/web3-providers-ws/README.md +++ b/packages/web3-providers-ws/README.md @@ -2,9 +2,10 @@ [![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 a sub-package of [web3.js][repo]. This is a websocket provider for [web3.js][repo]. + Please read the [documentation][docs] for more. ## Installation diff --git a/packages/web3-utils/README.md b/packages/web3-utils/README.md index e5d06bf6785..77b0a4e868c 100644 --- a/packages/web3-utils/README.md +++ b/packages/web3-utils/README.md @@ -2,9 +2,10 @@ [![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 a sub-package of [web3.js][repo]. + +This contains useful utility functions for Dapp developers. -This contains useful utility functions for Dapp developers. Please read the [documentation][docs] for more. ## Installation diff --git a/packages/web3/README.md b/packages/web3/README.md index 0e7b03f2cae..613671f037e 100644 --- a/packages/web3/README.md +++ b/packages/web3/README.md @@ -2,9 +2,9 @@ [![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] -This is a main package of [web3.js](https://github.com/ethereum/web3.js) +This is the main package of [web3.js][repo]. -Please read the main [readme](https://github.com/ethereum/web3.js) and [documentation](https://web3js.readthedocs.io) for more. +Please read the main [README][repo-readme] and [documentation][docs] for more. ## Installation @@ -20,6 +20,7 @@ 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 +[repo-readme]: https://github.com/ethereum/web3.js/blob/1.x/README.md [npm-image]: https://img.shields.io/npm/v/web3.svg [npm-url]: https://npmjs.org/package/web3 [deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3