better sentence grammar

web3 · Mar 31, 2020 · b445e95 · b445e95
1 parent 5a30953
commit b445e95
Show file tree

Hide file tree

Showing 18 changed files with 53 additions and 41 deletions.
diff --git 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
@@ -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
@@ -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,13 +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
-
+[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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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