mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-07-25 06:06:44 +00:00
Merge pull request #1474 from maticnetwork/krishang/remove-mumbai-from-readme
chore: Remove usage of Mumbai from README
This commit is contained in:
commit
c2531f4d03
4 changed files with 8 additions and 10 deletions
2
.github/ISSUE_TEMPLATE/bug.md
vendored
2
.github/ISSUE_TEMPLATE/bug.md
vendored
|
|
@ -20,7 +20,7 @@ Heimdall client version: [e.g. v0.2.10] <!--Can be found by running the command
|
||||||
|
|
||||||
OS & Version: Windows / Linux / OSX
|
OS & Version: Windows / Linux / OSX
|
||||||
|
|
||||||
Environment: Polygon Mainnet / Polygon Mumbai / Polygon Amoy / Devnet
|
Environment: Polygon Mainnet / Polygon Amoy / Devnet
|
||||||
|
|
||||||
Type of node: Validator / Sentry / Archive
|
Type of node: Validator / Sentry / Archive
|
||||||
|
|
||||||
|
|
|
||||||
2
.github/pull_request_template.md
vendored
2
.github/pull_request_template.md
vendored
|
|
@ -39,7 +39,7 @@ In case this PR includes changes that must be applied only to a subset of nodes,
|
||||||
- [ ] I have added tests to CI
|
- [ ] I have added tests to CI
|
||||||
- [ ] I have tested this code manually on local environment
|
- [ ] I have tested this code manually on local environment
|
||||||
- [ ] I have tested this code manually on remote devnet using express-cli
|
- [ ] I have tested this code manually on remote devnet using express-cli
|
||||||
- [ ] I have tested this code manually on mumbai/amoy
|
- [ ] I have tested this code manually on amoy
|
||||||
- [ ] I have created new e2e tests into express-cli
|
- [ ] I have created new e2e tests into express-cli
|
||||||
|
|
||||||
### Manual tests
|
### Manual tests
|
||||||
|
|
|
||||||
12
README.md
12
README.md
|
|
@ -1,9 +1,7 @@
|
||||||
# Bor Overview
|
# Bor Overview
|
||||||
Bor is the Official Golang implementation of the Polygon PoS blockchain. It is a fork of [geth](https://github.com/ethereum/go-ethereum) and is EVM compatible (upto London fork).
|
Bor is the official Golang implementation of the Polygon PoS blockchain. It is a fork of [geth](https://github.com/ethereum/go-ethereum) and is EVM compatible (upto London fork).
|
||||||
|
|
||||||
[](https://pkg.go.dev/github.com/maticnetwork/bor)
|
||||||
https://pkg.go.dev/badge/github.com/maticnetwork/bor
|
|
||||||
)](https://pkg.go.dev/github.com/maticnetwork/bor)
|
|
||||||
[](https://goreportcard.com/report/github.com/maticnetwork/bor)
|
[](https://goreportcard.com/report/github.com/maticnetwork/bor)
|
||||||

|

|
||||||
[](https://discord.com/invite/0xpolygonrnd)
|
[](https://discord.com/invite/0xpolygonrnd)
|
||||||
|
|
@ -13,15 +11,15 @@ https://pkg.go.dev/badge/github.com/maticnetwork/bor
|
||||||
|
|
||||||
The easiest way to get started with bor is to install the packages using the command below. Please take a look at the [releases](https://github.com/maticnetwork/bor/releases) section to find the latest stable version of bor.
|
The easiest way to get started with bor is to install the packages using the command below. Please take a look at the [releases](https://github.com/maticnetwork/bor/releases) section to find the latest stable version of bor.
|
||||||
|
|
||||||
curl -L https://raw.githubusercontent.com/maticnetwork/install/main/bor.sh | bash -s -- v0.4.0 <network> <node_type>
|
curl -L https://raw.githubusercontent.com/maticnetwork/install/main/bor.sh | bash -s -- v2.0.0 <network> <node_type>
|
||||||
|
|
||||||
The network accepts `mainnet`,`amoy` or `mumbai` and the node type accepts `validator` or `sentry` or `archive`. The installation script does the following things:
|
The network accepts `mainnet`, or `amoy` and the node type accepts `validator` or `sentry` or `archive`. The installation script does the following things:
|
||||||
- Create a new user named `bor`.
|
- Create a new user named `bor`.
|
||||||
- Install the bor binary at `/usr/bin/bor`.
|
- Install the bor binary at `/usr/bin/bor`.
|
||||||
- Dump the suitable config file (based on the network and node type provided) at `/var/lib/bor` and use it as the home dir.
|
- Dump the suitable config file (based on the network and node type provided) at `/var/lib/bor` and use it as the home dir.
|
||||||
- Create a systemd service named `bor` at `/lib/systemd/system/bor.service` which starts bor using the config file as `bor` user.
|
- Create a systemd service named `bor` at `/lib/systemd/system/bor.service` which starts bor using the config file as `bor` user.
|
||||||
|
|
||||||
The releases supports both the networks i.e. Polygon Mainnet, Amoy and Mumbai (Testnet) unless explicitly specified. Before the stable release for mainnet, pre-releases will be available marked with `beta` tag for deploying on Mumbai/Amoy (testnet). On sufficient testing, stable release for mainnet will be announced with a forum post.
|
The releases supports both the networks i.e. Polygon Mainnet, and Amoy (Testnet) unless explicitly specified. Before the stable release for mainnet, pre-releases will be available marked with `beta` tag for deploying on Amoy (testnet). On sufficient testing, stable release for mainnet will be announced with a forum post.
|
||||||
|
|
||||||
### Building from source
|
### Building from source
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -22,7 +22,7 @@ The ```bor server``` command runs the Bor client.
|
||||||
|
|
||||||
- ```bor.withoutheimdall```: Run without Heimdall service (for testing purpose) (default: false)
|
- ```bor.withoutheimdall```: Run without Heimdall service (for testing purpose) (default: false)
|
||||||
|
|
||||||
- ```chain```: Name of the chain to sync ('amoy', 'mumbai', 'mainnet') or path to a genesis file (default: mainnet)
|
- ```chain```: Name of the chain to sync ('amoy', 'mainnet') or path to a genesis file (default: mainnet)
|
||||||
|
|
||||||
- ```config```: Path to the TOML configuration file
|
- ```config```: Path to the TOML configuration file
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue