Skip to content

Commit

Permalink
more suaveup readme (#151)
Browse files Browse the repository at this point in the history
  • Loading branch information
metachris authored Jan 9, 2024
1 parent d3242f8 commit 3c93c40
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 4 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 14 additions & 0 deletions suave/suaveup/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion suave/suaveup/suaveup
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 3c93c40

Please sign in to comment.