diff --git a/README.md b/README.md index dbff15b..8ee64a1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # SUAVE Suapp Examples +This repository contains several [examples and useful references](/examples/) for building Suapps! + +--- + See also: - **https://github.com/flashbots/suave-geth** @@ -10,17 +14,21 @@ Writings: - https://writings.flashbots.net/the-future-of-mev-is-suave - https://writings.flashbots.net/mevm-suave-centauri-and-beyond +--- + ## Getting Started ```bash # Clone this repository -$ git clone https://github.com/flashbots/suapp-examples.git +$ git clone git@github.com:flashbots/suapp-examples.git # Checkout the suave-geth submodule $ git submodule init $ git submodule update ``` +--- + ## Compile the examples Install [Foundry](https://getfoundry.sh/): @@ -35,6 +43,14 @@ Compile: $ forge build ``` +--- + +## Start the local devnet + +See the instructions here: https://github.com/flashbots/suave-geth#starting-a-local-devnet + +--- + ## Run the examples Check out the [`/examples/`](/examples/) folder for several example Suapps and `main.go` files to deploy and run them!