Skip to content

Commit

Permalink
readme: clarify that usage is about main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
metachris committed Oct 19, 2022
1 parent 94ddac1 commit 36be409
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,12 +198,17 @@ A single MEV-Boost instance can be used by multiple beacon nodes and validators.

Aside from running MEV-Boost on your local network, you must configure:
* individual **beacon nodes** to connect to MEV-Boost. Beacon Node configuration varies by Consensus client. Guides for each client can be found on the [MEV-boost website](https://boost.flashbots.net/#block-356364ebd7cc424fb524428ed0134b21).
* individual **validators** to configure a preferred relay selection. Note: validators should take precautions to only connect to trusted relays. Read more about [the role of relays here](https://docs.flashbots.net/flashbots-mev-boost/relays).
* individual **validators** to configure a preferred relay selection. Note: validators should take precautions to only connect to trusted relays. Read more about [the role of relays here](https://docs.flashbots.net/flashbots-mev-boost/relays).

Lists of available relays are maintained by
* [Ethstaker](https://github.com/remyroy/ethstaker/blob/main/MEV-relay-list.md)
Lists of available relays are maintained by
* [Ethstaker](https://github.com/remyroy/ethstaker/blob/main/MEV-relay-list.md) [[2]](https://ethstaker.cc/mev-relay-list/)
* [Lido](https://research.lido.fi/t/lido-on-ethereum-call-for-relay-providers/2844)

## Note on usage documentation

The documentation in this README reflects the latest state of the `main` branch, which may have cli flags or functionality not present in the latest release.

Please take a look at the specific release documentation about the available command line flags: https://github.com/flashbots/mev-boost/releases

## Mainnet

Expand Down
9 changes: 8 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,11 @@ To create a new version (with tag), follow all these steps! They are necessary t
* Update `Version` in `config/vars.go` to next patch with `dev` suffix (eg. `v2.3.2-dev`), commit to main and push to Github
* Now push the main and stable branch, as well as the tag to Github: `git push origin main stable --tags`

Now check the Github CI actions for release activity: https://github.com/flashbots/mev-boost/actions - CI builds and pushes the Docker image, and prepares a new draft release in https://github.com/flashbots/mev-boost/releases. Open it, generate the description, review, add signoffs and testing, and publish.
Now check the Github CI actions for release activity: https://github.com/flashbots/mev-boost/actions
* CI builds and pushes the Docker image, and prepares a new draft release in https://github.com/flashbots/mev-boost/releases
* Open it and prepare the release:
* generate the description
* review
* add signoffs and testing
* add usage (`mev-boost -help`)
* publish

0 comments on commit 36be409

Please sign in to comment.