Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

[![Discord][discord-image]][discord-url] [![StackExchange][stackexchange-image]][stackexchange-url] [![NPM Package Version][npm-image-version]][npm-url] [![NPM Package Downloads][npm-image-downloads]][npm-url] [![Build Status][actions-image]][actions-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Lerna][lerna-image]][lerna-url] [![Netlify Status][netlify-image]][netlify-url] [![GitPOAP Badge][gitpoap-image]][gitpoap-url]

##### [Web3.js 4.x][4x-release] has been release. Checkout 4.x [API documentation and migration guide][4xdoc] for testing, early feedback and contributions.

This is the Ethereum [JavaScript API][docs]
which connects to the [Generic JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC) spec.

Expand Down Expand Up @@ -308,7 +310,8 @@ This project adheres to the [Release Guidelines](./REVIEW.md).
[stackexchange-url]: https://ethereum.stackexchange.com/questions/tagged/web3js
[gitpoap-image]: https://public-api.gitpoap.io/v1/repo/ChainSafe/web3.js/badge
[gitpoap-url]: https://www.gitpoap.io/gh/ChainSafe/web3.js

[4x-release]: https://github.com/ChainSafe/web3.js/releases/tag/v4.0.0-alpha.0
[4xdoc]: https://docs.web3js.org/
## Semantic versioning

This project follows [semver](https://semver.org/) as closely as possible **from version 1.3.0 onwards**. Earlier minor version bumps [might](https://github.com/ethereum/web3.js/issues/3758) have included breaking behavior changes.
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ web3.js is a collection of libraries that allow you to interact with a local or

The following documentation will guide you through :ref:`installing and running web3.js <adding-web3>` as well as providing an :ref:`API reference documentation <#id1>` with examples.

.. note:: `Web3.js 4.x <https://github.com/ChainSafe/web3.js/releases/tag/v4.0.0-alpha.0>`_ has been release. Checkout 4.x `API documentation and migration guide <https://docs.web3js.org/>`_ for testing, early feedback and contributions.

Contents:

:ref:`Keyword Index <genindex>`, :ref:`Search Page <search>`
Expand Down
6 changes: 5 additions & 1 deletion packages/web3/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3

##### [Web3.js 4.x][4x-release] has been release. Checkout 4.x [API documentation and migration guide][4xdoc] for testing, early feedback and contributions.

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is the main package of [web3.js][repo].
Expand All @@ -26,4 +28,6 @@ All the TypeScript typings are placed in the `types` folder.
[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
[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3
[4x-release]: https://github.com/ChainSafe/web3.js/releases/tag/v4.0.0-alpha.0
[4xdoc]: https://docs.web3js.org/
2 changes: 1 addition & 1 deletion packages/web3/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"scripts": {
"compile": "tsc -b tsconfig.json",
"dtslint": "dtslint --localTs ../../node_modules/typescript/lib types",
"postinstall": "echo \"WARNING: the web3-shh and web3-bzz api will be deprecated in the next version\""
"postinstall": "echo \"Web3.js 4.x alpha has been released for early testing and feedback. Checkout doc at https://docs.web3js.org/ \""
},
"authors": [
{
Expand Down