Tiny enhancements to the Installation section at README.md files (at …

…1.x) (#5572) * add installation using Yarn to README.md files
web3 · Nov 2, 2022 · 1b42e65 · 1b42e65
1 parent 32b4c79
commit 1b42e65
Show file tree

Hide file tree

Showing 23 changed files with 214 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,9 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node
+You can install the package either using [NPM](https://www.npmjs.com/package/web3) or using [Yarn](https://yarnpkg.com/package/web3)
+
+### Using NPM
 
 ```bash
 npm install web3

diff --git a/packages/web3-bzz/README.md b/packages/web3-bzz/README.md
@@ -10,12 +10,20 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-bzz) or using [Yarn](https://yarnpkg.com/package/web3-bzz)
+
+### Using NPM
 
 ```bash
 npm install web3-bzz
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-bzz
+```
+
 ## Usage
 
 ```js
@@ -32,4 +40,3 @@ All the TypeScript typings are placed in the `types` folder.
 [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
-
diff --git a/packages/web3-core-helpers/README.md b/packages/web3-core-helpers/README.md
@@ -1,19 +1,27 @@
 # web3-core-helpers
 
-[![NPM Package][npm-image]][npm-url] 
+[![NPM Package][npm-image]][npm-url]
 
 This is a sub-package of [web3.js][repo] with useful helper functions.
 
 Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-core-helpers) or using [Yarn](https://yarnpkg.com/package/web3-core-helpers)
+
+### Using NPM
 
 ```bash
 npm install web3-core-helpers
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-core-helpers
+```
+
 ## Usage
 
 ```js

diff --git a/packages/web3-core-method/README.md b/packages/web3-core-method/README.md
@@ -1,6 +1,6 @@
 # web3-core-method
 
-[![NPM Package][npm-image]][npm-url] 
+[![NPM Package][npm-image]][npm-url]
 
 This is a sub-package of [web3.js][repo].
 
@@ -10,12 +10,20 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-core-method) or using [Yarn](https://yarnpkg.com/package/web3-core-method)
+
+### Using NPM
 
 ```bash
 npm install web3-core-method
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-core-method
+```
+
 ## Usage
 
 ```js
@@ -40,4 +48,3 @@ All the TypeScript typings are placed in the `types` folder.
 [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
-
diff --git a/packages/web3-core-promievent/README.md b/packages/web3-core-promievent/README.md
@@ -1,6 +1,6 @@
 # web3-core-promievent
 
-[![NPM Package][npm-image]][npm-url] 
+[![NPM Package][npm-image]][npm-url]
 
 This is a sub-package of [web3.js][repo].
 
@@ -10,12 +10,20 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-core-promievent) or using [Yarn](https://yarnpkg.com/package/web3-core-promievent)
+
+### Using NPM
 
 ```bash
 npm install web3-core-promievent
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-core-promievent
+```
+
 ## Usage
 
 ```js
@@ -42,4 +50,3 @@ myFunc()
 [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
-
diff --git a/packages/web3-core-requestmanager/README.md b/packages/web3-core-requestmanager/README.md
@@ -1,6 +1,6 @@
 # web3-core-requestmanager
 
-[![NPM Package][npm-image]][npm-url] 
+[![NPM Package][npm-image]][npm-url]
 
 This is a sub-package of [web3.js][repo].
 
@@ -10,12 +10,20 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-core-requestmanager) or using [Yarn](https://yarnpkg.com/package/web3-core-requestmanager)
+
+### Using NPM
 
 ```bash
 npm install web3-core-requestmanager
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-core-requestmanager
+```
+
 ## Usage
 
 ```js
@@ -29,5 +37,3 @@ const requestManager = new Web3RequestManager(new Web3WsProvider('ws://localhost
 [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
-
-
diff --git a/packages/web3-core-subscriptions/README.md b/packages/web3-core-subscriptions/README.md
@@ -1,6 +1,6 @@
 # web3-core-subscriptions
 
-[![NPM Package][npm-image]][npm-url] 
+[![NPM Package][npm-image]][npm-url]
 
 This is a sub-package of [web3.js][repo]
 
@@ -10,12 +10,20 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-core-subscriptions) or using [Yarn](https://yarnpkg.com/package/web3-core-subscriptions)
+
+### Using NPM
 
 ```bash
 npm install web3-core-subscriptions
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-core-subscriptions
+```
+
 ## Usage
 
 ```js
@@ -45,5 +53,3 @@ myCoolLib.subscribe('newBlockHeaders', function(){ ... });
 [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
-
-
diff --git a/packages/web3-core/README.md b/packages/web3-core/README.md
@@ -10,12 +10,20 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-core) or using [Yarn](https://yarnpkg.com/package/web3-core)
+
+### Using NPM
 
 ```bash
 npm install web3-core
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-core
+```
+
 ## Usage
 
 ```js

diff --git a/packages/web3-eth-abi/README.md b/packages/web3-eth-abi/README.md
@@ -1,6 +1,6 @@
 # web3-eth-abi
 
-[![NPM Package][npm-image]][npm-url] 
+[![NPM Package][npm-image]][npm-url]
 
 This is a sub-package of [web3.js][repo].
 
@@ -10,12 +10,20 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth-abi) or using [Yarn](https://yarnpkg.com/package/web3-eth-abi)
+
+### Using NPM
 
 ```bash
 npm install web3-eth-abi
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-eth-abi
+```
+
 ## Usage
 
 ```js
@@ -33,4 +41,3 @@ All the TypeScript typings are placed in the `types` folder.
 [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
-
diff --git a/packages/web3-eth-accounts/README.md b/packages/web3-eth-accounts/README.md
@@ -1,6 +1,6 @@
 # web3-eth-accounts
 
-[![NPM Package][npm-image]][npm-url] 
+[![NPM Package][npm-image]][npm-url]
 
 This is a sub-package of [web3.js][repo].
 
@@ -10,12 +10,20 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth-accounts) or using [Yarn](https://yarnpkg.com/package/web3-eth-accounts)
+
+### Using NPM
 
 ```bash
 npm install web3-eth-accounts
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-eth-accounts
+```
+
 ## Usage
 
 ```js
@@ -40,4 +48,3 @@ All the TypeScript typings are placed in the `types` folder.
 [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
-
diff --git a/packages/web3-eth-contract/README.md b/packages/web3-eth-contract/README.md
@@ -1,6 +1,6 @@
 # web3-eth-contract
 
-[![NPM Package][npm-image]][npm-url] 
+[![NPM Package][npm-image]][npm-url]
 
 This is a sub-package of [web3.js][repo].
 
@@ -10,12 +10,20 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth-contract) or using [Yarn](https://yarnpkg.com/package/web3-eth-contract)
+
+### Using NPM
 
 ```bash
 npm install web3-eth-contract
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-eth-contract
+```
+
 ## Usage
 
 ```js
@@ -42,4 +50,3 @@ All the TypeScript typings are placed in the `types` folder.
 [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
-
diff --git a/packages/web3-eth-ens/README.md b/packages/web3-eth-ens/README.md
@@ -1,6 +1,6 @@
 # web3-eth-ens
 
-[![NPM Package][npm-image]][npm-url] 
+[![NPM Package][npm-image]][npm-url]
 
 This is a sub-package of [web3.js][repo].
 
@@ -10,12 +10,20 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth-ens) or using [Yarn](https://yarnpkg.com/package/web3-eth-ens)
+
+### Using NPM
 
 ```bash
 npm install web3-eth-ens
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-eth-ens
+```
+
 ## Usage
 
 ```js

diff --git a/packages/web3-eth-iban/README.md b/packages/web3-eth-iban/README.md
@@ -1,6 +1,6 @@
 # web3-eth-iban
 
-[![NPM Package][npm-image]][npm-url] 
+[![NPM Package][npm-image]][npm-url]
 
 This is a sub package of [web3.js][repo]
 
@@ -10,12 +10,20 @@ Please read the [documentation][docs] for more.
 
 ## Installation
 
-### Node.js
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth-iban) or using [Yarn](https://yarnpkg.com/package/web3-eth-iban)
+
+### Using NPM
 
 ```bash
 npm install web3-eth-iban
 ```
 
+### Using Yarn
+
+```bash
+yarn add web3-eth-iban
+```
+
 ## Usage
 
 ```js