From f15921f65537e3a186f4d24c37ca88c9d69c3576 Mon Sep 17 00:00:00 2001 From: James Kim Date: Wed, 18 Sep 2024 23:45:53 -0400 Subject: [PATCH] chore: update README and docs to include brew install --- README.md | 35 ++++++++++++------------ docs/src/getting-started/installation.md | 5 +++- 2 files changed, 21 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 5fe6c46c..388d898d 100644 --- a/README.md +++ b/README.md @@ -12,35 +12,26 @@ For **detailed instructions** and **usage guides**, refer to the [**📚 Supersim docs**](https://supersim.pages.dev). -## ❓ Why Supersim? - -While existing tools focus on isolated smart contract testing, Supersim provides a local development environment that mirrors the complex interactions of the Superchain ecosystem. Simulate entire cross-chain application flows, complete with deployed contracts, intricate message passing infrastructure, and OP-Stack specific logic with one command. - -Multichain development offers unique challenges: -- Coordinating startup and running multiple local chains -- Deploying system contracts to mimic desired functionality -- Running local offchain services like message relayers - -Supersim enables fast, local iteration on cross-chain features, with a simple developer interface. - ## 🚀 Getting Started ### 1. Install prerequisites: `foundry` `supersim` requires `anvil` to be installed. -Follow the guide [here](https://book.getfoundry.sh/getting-started/installation) to install the Foundry toolchain, which includes `anvil`. +Follow [this guide](https://book.getfoundry.sh/getting-started/installation) to install Foundry. ### 2. Install `supersim` +#### Homebrew (OS X, Linux) + +```sh +brew tap ethereum-optimism/tap +brew install supersim +``` #### Precompiled Binaries Download the executable for your platform from the [GitHub releases page](https://github.com/ethereum-optimism/supersim/releases). -#### Homebrew (OS X, Linux) - -*Coming soon* - ### 3. Start `supersim` in vanilla mode ```sh @@ -216,8 +207,16 @@ By default, interop contracts are not deployed on forked networks. To include th supersim fork --chains=op,base,zora --interop.enabled ``` -## 💬 Join Discord -Join our discord [here](https://discord.gg/Scdnrw8d) and reach out to us in the [interop-devex](https://discord.com/channels/1244729134312198194/1255653436079210496) channel. +## ❓ Why Supersim? + +While existing tools focus on isolated smart contract testing, Supersim provides a local development environment that mirrors the complex interactions of the Superchain ecosystem. Simulate entire cross-chain application flows, complete with deployed contracts, intricate message passing infrastructure, and OP-Stack specific logic with one command. + +Multichain development offers unique challenges: +- Coordinating startup and running multiple local chains +- Deploying system contracts to mimic desired functionality +- Running local offchain services like message relayers + +Supersim enables fast, local iteration on cross-chain features, with a simple developer interface. ## 🤝 Contributing diff --git a/docs/src/getting-started/installation.md b/docs/src/getting-started/installation.md index 528fdfa5..46a0a7f1 100644 --- a/docs/src/getting-started/installation.md +++ b/docs/src/getting-started/installation.md @@ -14,7 +14,10 @@ Download the executable for your platform from the [GitHub releases page](https: ### Homebrew (OS X, Linux) -*Coming soon* +```sh +brew tap ethereum-optimism/tap +brew install supersim +``` ## 3. Start `supersim` in vanilla mode