Skip to content

Commit

Permalink
chore: update readme (#2)
Browse files Browse the repository at this point in the history
* chore: update readme

* fix: fix readme typo

* chore: update readme
  • Loading branch information
Tjemmmic authored Dec 2, 2024
1 parent 4ca6ee0 commit d5f8816
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,42 @@ Before you can run this project, you will need to have the following software in
- [Rust](https://www.rust-lang.org/tools/install)
- [Forge](https://getfoundry.sh)

You will also need to install [cargo-tangle](https://crates.io/crates/cargo-tangle), our CLI tool for creating and
deploying Blueprints:

To install the Tangle CLI, run the following command:

> Supported on Linux, MacOS, and Windows (WSL2)
```bash
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/tangle-network/gadget/releases/download/cargo-tangle-v0.1.2/cargo-tangle-installer.sh | sh
```

Or, if you prefer to install the CLI from crates.io:

```bash
cargo install cargo-tangle --force # to get the latest version.
```

## 🚀 Getting Started

Once `cargo-tangle` is installed, you can create a new project with the following command:

```sh
cargo tangle blueprint create --name <project-name> --eigenlayer <type>
```
where `<project-name>` is the name of the project that will be generated, and `<type>` is BLS or ECDSA. If you aren't sure which type to use, you likely want the default: BLS. After all, this is the template for BLS. If you don't specify a type, it will default to BLS.

Upon running the above command, you will be prompted with questions regarding the setup for your generated project. If you aren't sure for any of them, you can just hit enter to select the default for that questions.

### Note
If you choose to use `foundry.toml` for the Soldeer configuration (the default), you will need to delete the following files from the `contracts` directory:
- `foundry.toml`
- `remappings.txt`
- `soldeer.lock`

This will allow the generated project to work out of the box. This will be fixed in the future, so that nothing needs to be deleted.

## 📚 Overview

This project is about creating a simple Hello World AVS for EigenLayer.
Expand Down

0 comments on commit d5f8816

Please sign in to comment.