diff --git a/RELEASE.md b/RELEASE.md index 2460c5b125a..eb22bd3aaae 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -82,7 +82,7 @@ The following describes the steps required to release a new version of `web3.js` 1. Create release commit and tags e.g. `lerna version 1.2.7-rc.0 --no-push` 1. (updates package version numbers, builds minified file (for `1.x`), creates release commit and tags.) 1. For `1.x`, save [index.html](https://github.com/ethereum/web3.js/blob/1.x/scripts/html/index.html) to your local machine and test loading minified file to ensure its integrity. Be sure to delete `index.html` after. -1. Check git working state is clean. Sometimes files modified by gulp are not included. If so, run `git commit --amend` and `git tag -d 1.2.7-rc.0` and `git tag 1.2.7-rc.0`. +1. Check git working state is clean. Sometimes files modified by gulp are not included. If so, run `git commit --amend` and `git tag -d 1.2.7-rc.0` and `git tag 1.2.7-rc.0`. 1. Push release branch to origin with tags `git push origin release/1.2.7 --follow-tags`. 1. Create release PR as draft ([example](https://github.com/ethereum/web3.js/pull/3351)). 1. Ensure CI is green / passing. @@ -94,11 +94,11 @@ The following describes the steps required to release a new version of `web3.js` 1. (The build may sometimes need to be manually triggered in ReadTheDocs admin panel. If the version does not appear, create a build of a previous version to refresh the list.) 1. Activate the new version. 1. Request PR review from key contributors: - 1. Chris from EthereumJS ([@cgewecke](https://github.com/cgewecke)) - 1. Patricio from Nomic Labs ([@alcuadrado](https://github.com/alcuadrado)) - 1. Michael from Embark ([@michaelsbradleyjr](https://github.com/michaelsbradleyjr)) - 1. Nicholas from Truffle ([@gnidan](https://github.com/gnidan)) - 1. If touches or affects ENS: Nick Johnson ([@Arachnid](https://github.com/Arachnid)) + 1. Chris from EthereumJS ([@cgewecke](https://github.com/cgewecke)) + 1. Patricio from Nomic Labs ([@alcuadrado](https://github.com/alcuadrado)) + 1. Michael from Embark ([@michaelsbradleyjr](https://github.com/michaelsbradleyjr)) + 1. Nicholas from Truffle ([@gnidan](https://github.com/gnidan)) + 1. If touches or affects ENS: Nick Johnson ([@Arachnid](https://github.com/Arachnid)) 1. Wait 1 week for community discourse and 2 reviewer approvals. 1. (if release is an emergency patch, time limit may be reduced relative to severity.) @@ -107,7 +107,7 @@ The following describes the steps required to release a new version of `web3.js` 1. Create GitHub draft release from text of `rc` release. 1. Checkout release branch (e.g. `release/1.2.7`). 1. Create and push release commit and tags: `lerna version 1.2.7 --force-publish --no-push` -1. Check git working state is clean. Sometimes files modified by gulp are not included. If so, run `git commit --amend` and `git tag -d 1.2.7` and `git tag 1.2.7`. +1. Check git working state is clean. Sometimes files modified by gulp are not included. If so, run `git commit --amend` and `git tag -d 1.2.7` and `git tag 1.2.7`. 1. Push release branch to origin with tags `git push origin release/1.2.7 --follow-tags`. 1. Publish the GitHub release. 1. A GitHub Webhook should trigger the ReadTheDocs build after the release is published. @@ -127,4 +127,4 @@ The following describes the steps required to release a new version of `web3.js` 1. Santiago from OpenZeppelin ([@spalladino](https://github.com/spalladino)) 1. Pedro from WalletConnect ([@pedrouid](https://github.com/pedrouid)) 1. Josh from FunFair ([@joshstevens19](https://github.com/joshstevens19)) - 1. Truffle, Gnosis, Aragon, Embark, Alchemy, Buidler, Remix \ No newline at end of file + 1. Truffle, Gnosis, Aragon, Embark, Alchemy, Buidler, Remix diff --git a/docs/getting-started.rst b/docs/getting-started.rst index b8371d5755b..303b22857cd 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -3,10 +3,10 @@ Getting Started =============== -The web3.js library is a collection of modules that contain specific functionality for the ethereum ecosystem. +The web3.js library is a collection of modules that contain functionality for the ethereum ecosystem. - ``web3-eth`` is for the ethereum blockchain and smart contracts. -- ``web3-shh`` is for the whisper protocol to communicate p2p and broadcast. +- ``web3-shh`` is for the whisper protocol, to communicate p2p and broadcast. - ``web3-bzz`` is for the swarm protocol, the decentralized file storage. - ``web3-utils`` contains useful helper functions for Dapp developers. @@ -27,14 +27,16 @@ First you need to get web3.js into your project. This can be done using the foll After that you need to create a web3 instance and set a provider. -Most Ethereum-supported browsers like MetaMask and TrustWallet have an [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compliant provider available at ``window.ethereum``. For web3.js, check ``Web3.givenProvider``. +Most Ethereum-supported browsers like MetaMask have an `EIP-1193 `_ compliant provider available at ``window.ethereum``. + +For web3.js, check ``Web3.givenProvider``. If this property is ``null`` you should connect to a remote/local node. .. code-block:: javascript - // in node.js use: var Web3 = require('web3'); + // In Node.js use: const Web3 = require('web3'); - var web3 = new Web3(Web3.givenProvider || "ws://localhost:8545"); + let web3 = new Web3(Web3.givenProvider || "ws://localhost:8545"); That's it! now you can use the ``web3`` object. diff --git a/docs/index.rst b/docs/index.rst index c6b9c3cb2d1..b1f3bbff733 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,11 +3,9 @@ web3.js - Ethereum JavaScript API ================================= -web3.js is a collection of libraries that allow you to interact with a local or remote ethereum node -using HTTP, IPC or WebSocket. +web3.js is a collection of libraries that allow you to interact with a local or remote ethereum node using HTTP, IPC or WebSocket. -The following documentation will guide you through :ref:`installing and running web3.js ` -as well as providing an :ref:`API reference documentation <#id1>` with examples. +The following documentation will guide you through :ref:`installing and running web3.js ` as well as providing an :ref:`API reference documentation <#id1>` with examples. Contents: @@ -41,3 +39,5 @@ Contents: web3-utils web3-admin + +Special thanks to `Netlify `_ for providing build and deploy services for our end-to-end integration tests. \ No newline at end of file