diff --git a/Makefile b/Makefile index 59c19ef0d..4d2312551 100644 --- a/Makefile +++ b/Makefile @@ -15,9 +15,9 @@ geth: suave: $(GORUN) build/ci.go install ./cmd/geth - cd $(GOBIN) && rm -f suave && ln -s geth suave + cd $(GOBIN) && rm -f suave-geth && ln -s geth suave-geth @echo "Done building." - @echo "Run \"$(GOBIN)/suave\" to launch SUAVE." + @echo "Run \"$(GOBIN)/suave-geth\" to launch SUAVE." all: $(GORUN) build/ci.go install diff --git a/README.md b/README.md index fcc3ebd77..0662280cb 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,19 @@ For a deeper dive, check out the following links: ### Starting a local devnet +You can use `suave-geth` to start a local SUAVE devnet. -There's two ways to start the local devnet: with Docker or directly using the suave-geth binary. +There's multiple ways to get `suave-geth`: + +1. Install the latest release binary +2. Build from source +3. Use Docker + +#### Install the latest suave-geth release binary + +```bash +curl -L https://suaveup.flashbots.net | bash +``` #### Building from source diff --git a/suave/suaveup/README.md b/suave/suaveup/README.md index 7c6fb5a56..7a24866ac 100644 --- a/suave/suaveup/README.md +++ b/suave/suaveup/README.md @@ -1,3 +1,17 @@ # `suaveup` Update or revert to a specific SUAVE release with ease. + +Install the latest version of suave-geth: + +```bash +curl -L https://suaveup.flashbots.net | bash +``` + +Or a specific version (i.e. v0.1.0): + +```bash +curl -L https://suaveup.flashbots.net | bash -s -- --version v0.1.0 +``` + +You can also just download the [`suaveup` bash script](./suaveup) and use it without curl. diff --git a/suave/suaveup/suaveup b/suave/suaveup/suaveup index 79355cc55..62602c6e3 100755 --- a/suave/suaveup/suaveup +++ b/suave/suaveup/suaveup @@ -32,7 +32,7 @@ if [ -z "$VERSION" ]; then VERSION=$(get_latest_release) fi -echo "🔎 Downloading version: $VERSION ..." +echo "🔎 Downloading suave-geth $VERSION ..." if [ "$(uname -m)" = "x86_64" ]; then ARCH_STRING="linux_amd64"