Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Tiny enhancements to the Installation section at README.md files (at 1.x) #5572

Merged
merged 5 commits into from
Nov 2, 2022
Merged

Tiny enhancements to the Installation section at README.md files (at 1.x) #5572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1e534fb
add installation using Yarn to README.md files
Muhammad-Altabba Oct 27, 2022
681f889
Merge branch '1.x' into feature/5559/1.x/enhance-readme-installation-…
jdevcs Oct 28, 2022
cd97916
revert unintended formatting at README.md files
Muhammad-Altabba Oct 30, 2022
70d9193
change a whitespace to restart the hanged GitHub actions
Muhammad-Altabba Nov 2, 2022
890c7a0
change a whitespace to restart the hanged GitHub actions
Muhammad-Altabba Nov 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 9 additions & 2 deletions packages/web3-bzz/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

12 changes: 10 additions & 2 deletions packages/web3-core-helpers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
13 changes: 10 additions & 3 deletions packages/web3-core-method/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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].

Expand All @@ -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
Expand All @@ -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

13 changes: 10 additions & 3 deletions packages/web3-core-promievent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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].

Expand All @@ -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
Expand All @@ -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

14 changes: 10 additions & 4 deletions packages/web3-core-requestmanager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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].

Expand All @@ -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
Expand All @@ -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


14 changes: 10 additions & 4 deletions packages/web3-core-subscriptions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]

Expand All @@ -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
Expand Down Expand Up @@ -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


10 changes: 9 additions & 1 deletion packages/web3-core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 10 additions & 3 deletions packages/web3-eth-abi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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].

Expand All @@ -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
Expand All @@ -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

13 changes: 10 additions & 3 deletions packages/web3-eth-accounts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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].

Expand All @@ -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
Expand All @@ -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

13 changes: 10 additions & 3 deletions packages/web3-eth-contract/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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].

Expand All @@ -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
Expand All @@ -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

12 changes: 10 additions & 2 deletions packages/web3-eth-ens/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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].

Expand All @@ -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
Expand Down
12 changes: 10 additions & 2 deletions packages/web3-eth-iban/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]

Expand All @@ -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
Expand Down
Loading