Skip to content

Commit

Permalink
fix: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tjemmmic committed Jan 22, 2025
1 parent 97a90f6 commit 30f76a4
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

**A simple Hello World AVS for EigenLayer with the ECDSA-based Contract Configuration**

## 📚 Overview

This project is about creating a simple Hello World AVS for EigenLayer.
An AVS (Actively Validated Service) is an off-chain service that runs arbitrary computations for a user-specified period of time.

## 📚 Prerequisites

Before you can run this project, you will need to have the following software installed on your machine:
Expand Down Expand Up @@ -43,17 +48,11 @@ cargo tangle blueprint create --name ecdsa-test --eigenlayer ECDSA
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.
If the soldeer fails to update/install the necessary dependencies, you may just have to run it manually with the following command:

## 📚 Overview

This project is about creating a simple Hello World AVS for EigenLayer.
An AVS (Actively Validated Service) is an off-chain service that runs arbitrary computations for a user-specified period of time.
```bash
forge soldeer update -d
```

## 📜 License

Expand Down

0 comments on commit 30f76a4

Please sign in to comment.