diff --git a/README.md b/README.md index 1b1958c865b..df7e017da49 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ # Web3.js +[![Dependency Status][downloads-image]][npm-url] ![Unit Test Coverage](https://img.shields.io/codecov/c/github/web3/web3.js/4.x?label=unit%20test%20coverage) +![Commit Activity](https://img.shields.io/github/commit-activity/m/web3/web3.js/4.x?label=commit%20activity%20on%204.x) +![Contributors](https://img.shields.io/github/contributors/web3/web3.js?label=contributors%20on%20all%20branches) + ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) @@ -42,25 +46,26 @@ yarn add web3 ## Architecture Overview -| Package | Version | License | Docs | Description | -| ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| [web3](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | :rotating_light: Entire Web3.js offering (includes all packages) | -| [web3-core](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-core) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Core functions for web3.js packages | -| [web3-eth](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-eth) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Modules to interact with the Ethereum blockchain and smart contracts | -| [web3-eth-abi](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-abi) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-eth-abi) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Functions for encoding and decoding EVM in/output | -| [web3-eth-accounts](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-accounts) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-eth-accounts) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Functions for managing Ethereum accounts and signing | -| [web3-eth-contract](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-contract) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-eth-contract) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | The contract package contained in [web3-eth](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth) | -| [web3-eth-ens](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-ens) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-eth-ens) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Functions for interacting with the Ethereum Name Service | -| [web3-eth-iban](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-iban) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-eth-iban) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Functionality for converting Ethereum addressed to IBAN addressed and vice versa | -| [web3-eth-personal](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-personal) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-eth-personal) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Module to interact with the Ethereum blockchain accounts stored in the node | -| [web3-eth-tx](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-tx) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-eth-tx) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | [@ethereumjs/tx](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/tx) wrapper class | -| [web3-net](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-net) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-net) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Functions to interact with an Ethereum node's network properties | -| [web3-providers-http](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-http) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-providers-http) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Web3.js provider for the HTTP protocol | -| [web3-providers-ipc](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-ipc) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-providers-ipc) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Web3.js provider for IPC | -| [web3-providers-ws](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-ws) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-providers-ws) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Web3.js provider for the Websocket protocol | -| [web3-utils](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-utils) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-utils) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Useful utility functions for Dapp developers | -| [web3-validator](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-validator) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-validator) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Utilities for validating objects | -| [web3-types](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-types) | [![npm](https://img.shields.io/npm/v/web3)](https://www.npmjs.com/package/web3-types) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Shared useable types | +| Package | Version | License | Docs | Description | +| ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| [web3](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3%2Fpackage.json)](https://www.npmjs.com/package/web3) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | :rotating_light: Entire Web3.js offering (includes all packages) | +| [web3-core](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-core) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-core%2Fpackage.json)](https://www.npmjs.com/package/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Core functions for web3.js packages | +| [web3-errors](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-errors) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-errors%2Fpackage.json)](https://www.npmjs.com/package/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Errors Objects | +| [web3-eth](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth%2Fpackage.json)](https://www.npmjs.com/package/web3-eth) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Modules to interact with the Ethereum blockchain and smart contracts | +| [web3-eth-abi](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-abi) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-abi%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-abi) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Functions for encoding and decoding EVM in/output | +| [web3-eth-accounts](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-accounts) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-accounts%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-accounts) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Functions for managing Ethereum accounts and signing | +| [web3-eth-contract](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-contract) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-contract%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-contract) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | The contract package contained in [web3-eth](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth) | +| [web3-eth-ens](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-ens) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-ens%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-ens) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Functions for interacting with the Ethereum Name Service | +| [web3-eth-iban](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-iban) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-iban%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-iban) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Functionality for converting Ethereum addressed to IBAN addressed and vice versa | +| [web3-eth-personal](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-personal) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-personal%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-personal) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Module to interact with the Ethereum blockchain accounts stored in the node | +| [web3-net](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-net) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-net%2Fpackage.json)](https://www.npmjs.com/package/web3-net) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Functions to interact with an Ethereum node's network properties | +| [web3-providers-http](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-http) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-http%2Fpackage.json)](https://www.npmjs.com/package/web3-providers-http) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Web3.js provider for the HTTP protocol | +| [web3-providers-ipc](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-ipc) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-ipc%2Fpackage.json)](https://www.npmjs.com/package/web3-providers-ipc) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Web3.js provider for IPC | +| [web3-providers-ws](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-ws) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-ws%2Fpackage.json)](https://www.npmjs.com/package/web3-providers-ws) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Web3.js provider for the Websocket protocol | +| [web3-rpc-methods](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-rpc-methods) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-rpc-methods%2Fpackage.json)](https://www.npmjs.com/package/web3-types) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | RPC Methods | +| [web3-types](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-types) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-types%2Fpackage.json)](https://www.npmjs.com/package/web3-types) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Shared useable types | +| [web3-utils](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-utils) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-utils%2Fpackage.json)](https://www.npmjs.com/package/web3-utils) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Useful utility functions for Dapp developers | +| [web3-validator](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-validator) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-validator%2Fpackage.json)](https://www.npmjs.com/package/web3-validator) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://web3js.readthedocs.io) | Utilities for validating objects | ## Package.json Scripts @@ -74,3 +79,6 @@ yarn add web3 | test | Uses `jest` to run unit tests in each package | | test:integration | Uses `jest` to run tests under `/test/integration` in each package | | test:unit | Uses `jest` to run tests under `/test/unit` in each package | + +[npm-url]: https://npmjs.org/package/web3 +[downloads-image]: https://img.shields.io/npm/dm/web3?label=npm%20downloads diff --git a/packages/web3-core/README.md b/packages/web3-core/README.md index a6abf819426..a5a2110742c 100644 --- a/packages/web3-core/README.md +++ b/packages/web3-core/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-core [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-core -[npm-image]: https://img.shields.io/npm/v/web3-core.svg -[npm-url]: https://npmjs.com/package/web3-core -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-core -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-core -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-core -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-core +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-core%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-core +[downloads-image]: https://img.shields.io/npm/dm/web3-core?label=npm%20downloads diff --git a/packages/web3-errors/README.md b/packages/web3-errors/README.md index beeba1d0479..9a68b9a7b8d 100644 --- a/packages/web3-errors/README.md +++ b/packages/web3-errors/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-errors [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-errors -[npm-image]: https://img.shields.io/npm/v/web3-errors.svg -[npm-url]: https://npmjs.org/packages/web3-errors -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-errors -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-errors -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-errors -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-errors +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-errors%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-errors +[downloads-image]: https://img.shields.io/npm/dm/web3-errors?label=npm%20downloads diff --git a/packages/web3-eth-abi/README.md b/packages/web3-eth-abi/README.md index 781856e3736..bbeb96bf2c4 100644 --- a/packages/web3-eth-abi/README.md +++ b/packages/web3-eth-abi/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-eth-abi [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-abi -[npm-image]: https://img.shields.io/npm/v/web3-eth-abi-method.svg -[npm-url]: https://npmjs.com/package/web3-eth-abi -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-eth-abi -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-eth-abi -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-eth-abi -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-eth-abi +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-abi%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-eth-abi +[downloads-image]: https://img.shields.io/npm/dm/web3-eth-abi?label=npm%20downloads diff --git a/packages/web3-eth-accounts/README.md b/packages/web3-eth-accounts/README.md index 03b73828019..3ca18c2a460 100644 --- a/packages/web3-eth-accounts/README.md +++ b/packages/web3-eth-accounts/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-eth-accounts [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-accounts -[npm-image]: https://img.shields.io/npm/v/web3-eth-accounts-method.svg -[npm-url]: https://npmjs.com/package/web3-eth-accounts -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-eth-accounts -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-eth-accounts -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-eth-accounts -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-eth-accounts +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-accounts%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-eth-accounts +[downloads-image]: https://img.shields.io/npm/dm/web3-eth-accounts?label=npm%20downloads diff --git a/packages/web3-eth-contract/README.md b/packages/web3-eth-contract/README.md index 0a20500487b..9de73d9556e 100644 --- a/packages/web3-eth-contract/README.md +++ b/packages/web3-eth-contract/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -78,9 +77,6 @@ The Typescript support for fixed length array types are supported up 30 elements [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-contract -[npm-image]: https://img.shields.io/npm/v/web3-core-method.svg -[npm-url]: https://npmjs.org/packages/web3-eth-contract -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-eth-contract -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-eth-contract -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-eth-contract -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-eth-contract +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-contract%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-eth-contract +[downloads-image]: https://img.shields.io/npm/dm/web3-eth-contract?label=npm%20downloads diff --git a/packages/web3-eth-ens/README.md b/packages/web3-eth-ens/README.md index e0134860b68..ea4f306a767 100644 --- a/packages/web3-eth-ens/README.md +++ b/packages/web3-eth-ens/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-eth-ens [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-ens -[npm-image]: https://img.shields.io/npm/v/web3-core-method.svg -[npm-url]: https://npmjs.org/packages/web3-eth-ens -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-eth-ens -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-eth-ens -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-eth-ens -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-eth-ens +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-ens%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-eth-ens +[downloads-image]: https://img.shields.io/npm/dm/web3-eth-ens?label=npm%20downloads diff --git a/packages/web3-eth-iban/README.md b/packages/web3-eth-iban/README.md index d614eda4fb1..11c7e52305b 100644 --- a/packages/web3-eth-iban/README.md +++ b/packages/web3-eth-iban/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-eth-iban [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-iban -[npm-image]: https://img.shields.io/npm/v/web3-core-method.svg -[npm-url]: https://npmjs.org/packages/web3-eth-iban -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-eth-iban -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-eth-iban -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-eth-iban -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-eth-iban +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-iban%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-eth-iban +[downloads-image]: https://img.shields.io/npm/dm/web3-eth-iban?label=npm%20downloads diff --git a/packages/web3-eth-personal/README.md b/packages/web3-eth-personal/README.md index b6d4c7cb213..857d97d88f2 100644 --- a/packages/web3-eth-personal/README.md +++ b/packages/web3-eth-personal/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-eth-personal [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-personal -[npm-image]: https://img.shields.io/npm/v/web3-eth-personal.svg -[npm-url]: https://npmjs.org/packages/web3-eth-personal -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-eth-personal -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-eth-personal -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-eth-personal -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-eth-personal +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-personal%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-eth-personal +[downloads-image]: https://img.shields.io/npm/dm/web3-eth-personal?label=npm%20downloads diff --git a/packages/web3-eth/README.md b/packages/web3-eth/README.md index 7126a669e70..a7d675b599c 100644 --- a/packages/web3-eth/README.md +++ b/packages/web3-eth/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-eth [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth -[npm-image]: https://img.shields.io/npm/v/web3-eth-method.svg -[npm-url]: https://npmjs.com/package/web3-eth -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-eth -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-eth -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-eth -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-eth +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-eth +[downloads-image]: https://img.shields.io/npm/dm/web3-eth?label=npm%20downloads diff --git a/packages/web3-net/README.md b/packages/web3-net/README.md index 7c148a6c00c..6e19cf6a079 100644 --- a/packages/web3-net/README.md +++ b/packages/web3-net/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-net [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-net -[npm-image]: https://img.shields.io/npm/v/web3-net-method.svg -[npm-url]: https://npmjs.com/package/web3-net -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-net -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-net -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-net -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-net +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-net%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-net +[downloads-image]: https://img.shields.io/npm/dm/web3-net?label=npm%20downloads diff --git a/packages/web3-providers-http/README.md b/packages/web3-providers-http/README.md index df4b178e9f7..12c52dd4c1e 100644 --- a/packages/web3-providers-http/README.md +++ b/packages/web3-providers-http/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-providers-http [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-providers-http -[npm-image]: https://img.shields.io/npm/v/web3-providers-http.svg -[npm-url]: https://npmjs.org/packages/web3-providers-http -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-providers-http -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-providers-http -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-providers-http -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-providers-http +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-http%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-providers-http +[downloads-image]: https://img.shields.io/npm/dm/web3-providers-http?label=npm%20downloads diff --git a/packages/web3-providers-ipc/README.md b/packages/web3-providers-ipc/README.md index 27e31da1ea8..39913cd9584 100644 --- a/packages/web3-providers-ipc/README.md +++ b/packages/web3-providers-ipc/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-providers-ipc [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-probiders-ipc -[npm-image]: https://img.shields.io/npm/v/web3-core-method.svg -[npm-url]: https://npmjs.org/packages/web3-providers-ipc -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-providers-ipc -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-providers-ipc -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-providers-ipc -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-providers-ipc +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-ipc%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-providers-ipc +[downloads-image]: https://img.shields.io/npm/dm/web3-providers-ipc?label=npm%20downloads diff --git a/packages/web3-providers-ws/README.md b/packages/web3-providers-ws/README.md index 46c29cdba80..942839b6b23 100644 --- a/packages/web3-providers-ws/README.md +++ b/packages/web3-providers-ws/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-providers-ws [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-providers-ws -[npm-image]: https://img.shields.io/npm/v/web3-providers-ws-method.svg -[npm-url]: https://npmjs.com/package/web3-providers-ws -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-providers-ws -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-providers-ws -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-providers-ws -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-providers-ws +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-ws%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-providers-ws +[downloads-image]: https://img.shields.io/npm/dm/web3-providers-ws?label=npm%20downloads diff --git a/packages/web3-rpc-methods/README.md b/packages/web3-rpc-methods/README.md index a2bd72e431d..2b46d105286 100644 --- a/packages/web3-rpc-methods/README.md +++ b/packages/web3-rpc-methods/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-rpc-methods [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-rpc-methods -[npm-image]: https://img.shields.io/npm/v/web3-core-method.svg -[npm-url]: https://npmjs.org/packages/web3-package-tempalte -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-package-tempalte -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-package-tempalte -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-package-tempalte -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-package-tempalte +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-rpc-methods%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-rpc-methods +[downloads-image]: https://img.shields.io/npm/dm/web3-rpc-methods?label=npm%20downloads diff --git a/packages/web3-types/README.md b/packages/web3-types/README.md index cc581924a3d..7c15e2dc2e0 100644 --- a/packages/web3-types/README.md +++ b/packages/web3-types/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -55,9 +54,6 @@ yarn add web3-types [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-types -[npm-image]: https://img.shields.io/npm/v/web3-types.svg -[npm-url]: https://npmjs.org/packages/web3-types -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=packages/web3-types -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=packages/web3-types -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=packages/web3-types -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=packages/web3-types +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-types%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-types +[downloads-image]: https://img.shields.io/npm/dm/web3-types?label=npm%20downloads diff --git a/packages/web3-utils/README.md b/packages/web3-utils/README.md index f898dfa1e4f..78cce56e322 100644 --- a/packages/web3-utils/README.md +++ b/packages/web3-utils/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -68,9 +67,6 @@ console.log(Web3Utils); [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-utils -[npm-image]: https://img.shields.io/npm/v/web3-utils.svg -[npm-url]: https://npmjs.org/packages/web3-utils -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=packages/web3-utils -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=packages/web3-utils -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=packages/web3-utils -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=packages/web3-utils +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-utils%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-utils +[downloads-image]: https://img.shields.io/npm/dm/web3-utils?label=npm%20downloads diff --git a/packages/web3-validator/README.md b/packages/web3-validator/README.md index 8e0f8abe54d..21c9bd38329 100644 --- a/packages/web3-validator/README.md +++ b/packages/web3-validator/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -94,9 +93,6 @@ The implementation of the validator is extension of [JSON-Schema-Draft07](https: [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-validator -[npm-image]: https://img.shields.io/npm/v/web3-core-method.svg -[npm-url]: https://npmjs.com/package/web3-validator -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-validator -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-validator -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-validator -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-validator +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-validator%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-validator +[downloads-image]: https://img.shields.io/npm/dm/web3-validator?label=npm%20downloads diff --git a/packages/web3/README.md b/packages/web3/README.md index 2dc542eafa2..59c86075531 100644 --- a/packages/web3/README.md +++ b/packages/web3/README.md @@ -7,10 +7,9 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] -This is the main package of [web3.js](https://github.com/ChainSafe/web3.js). +This is the main package of [web3.js](repo). `web3` contains the ideal setup for a Web3.js package. @@ -55,9 +54,6 @@ yarn add web3 [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3 -[npm-image]: https://img.shields.io/npm/v/web3-core-method.svg -[npm-url]: https://npmjs.org/packages/web3 -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3 -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3 -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3 -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3 +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3 +[downloads-image]: https://img.shields.io/npm/dm/web3?label=npm%20downloads diff --git a/tools/web3-packagetemplate/README.md b/tools/web3-packagetemplate/README.md index 8c18b92f9c8..4fe1e0036b6 100644 --- a/tools/web3-packagetemplate/README.md +++ b/tools/web3-packagetemplate/README.md @@ -7,8 +7,7 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -54,10 +53,7 @@ yarn add web3-packagetemplate | test:unit | Uses `jest` to run tests under `/test/unit` | [docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/ -[npm-image]: https://img.shields.io/npm/v/web3-core-method.svg -[npm-url]: https://npmjs.org/packages/web3-package-tempalte -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3-package-tempalte -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3-package-tempalte -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3-package-tempalte -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3-package-tempalte +[repo]: https://github.com/web3/web3.js/tree/4.x/tools/web3-packagetemplate +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=tools%2Fweb3-packagetemplate%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-packagetemplate +[downloads-image]: https://img.shields.io/npm/dm/web3-packagetemplate?label=npm%20downloads diff --git a/tools/web3-plugin-example/README.md b/tools/web3-plugin-example/README.md index 8035aafd005..f06e2d7d065 100644 --- a/tools/web3-plugin-example/README.md +++ b/tools/web3-plugin-example/README.md @@ -7,10 +7,9 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package][npm-image]][npm-url] -[![Dependency Status][deps-image]][deps-url] -[![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![Downloads][downloads-image]][npm-url] -This is an example of a plugin implementation for [web3.js](https://github.com/ChainSafe/web3.js). +This is an example of a plugin implementation for [web3.js][repo]. ## Installation @@ -52,10 +51,7 @@ yarn add web3-plugin-example | test:unit | Uses `jest` to run tests under `/test/unit` | [docs]: https://docs.web3js.org/ -[repo]: https://github.com/ethereum/web3.js -[npm-image]: https://img.shields.io/npm/v/web3-core-method.svg -[npm-url]: https://npmjs.org/packages/web3 -[deps-image]: https://david-dm.org/ethereum/web3.js/4.x/status.svg?path=tools/web3 -[deps-url]: https://david-dm.org/ethereum/web3.js/4.x?path=tools/web3 -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/4.x/dev-status.svg?path=tools/web3 -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/4.x?type=dev&path=tools/web3 +[repo]: https://github.com/web3/web3.js/tree/4.x/tools/web3-plugin-example +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=tools%2Fweb3-plugin-example%2Fpackage.json +[npm-url]: https://npmjs.org/package/web3-plugin-example +[downloads-image]: https://img.shields.io/npm/dm/web3-plugin-example?label=npm%20downloads