docs: overhaul README.md #1105
Open
docs: overhaul README.md #1105
+275
−243
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
0xClandestine
added
📖 Documentation
0xClandestine
force-pushed
the
docs/overhaul-readme
branch
from
dbeb2b0 to
2d28693
Compare
0xClandestine
requested review from
seanmcgary,
shrimalmadhur,
scotthconner,
bowenli86,
jbrower95,
nadir-akhtar,
stevennevins,
wadealexc,
0xrajath,
gpsanant,
8sunyuan,
ypatil12,
MinisculeTarantula and
eigenmikem
0xClandestine
commented
Feb 17, 2025
| [](https://github.com/Layr-Labs/eigenlayer-contracts/graphs/contributors) | ||
| [](https://github.com/Layr-Labs/eigenlayer-contracts/commits/master) | ||
| [](https://github.com/Layr-Labs/eigenlayer-contracts/releases) | ||
| [](https://coveralls.io/github/Layr-Labs/eigenlayer-contracts) |
There was a problem hiding this comment.
TODO: I need to get this to properly parse coverage.
| [](https://github.com/Layr-Labs/eigenlayer-contracts/commits/master) | ||
| [](https://github.com/Layr-Labs/eigenlayer-contracts/releases) | ||
| [](https://coveralls.io/github/Layr-Labs/eigenlayer-contracts) | ||
| [](https://github.com/Layr-Labs/eigenlayer-contracts) |
There was a problem hiding this comment.
TODO: Solidity version could be more explicit, should also link to solidity docs rather than our repo.
This was referenced Feb 19, 2025
Closed
0xClandestine
force-pushed
the
docs/overhaul-readme
branch
from
9c7f8aa to
833fcae
Compare
bowenli86
approved these changes
Feb 19, 2025
|
|
||
| Additionally, to run all tests in a forked environment, [install yq](https://mikefarah.gitbook.io/yq/v/v3.x/). Then, set up your environment by running the following command. | ||
|
|
||
| `source bin/source-env.sh [goerli|local]` |
There was a problem hiding this comment.
there's only holesky, no goerli anymore
i had a PR which changed it, but it's never merged #764
|
|
||
| You can view the deployed contract addresses below, or check out the code itself on the [`testnet-holesky`](https://github.com/Layr-Labs/eigenlayer-contracts/tree/testnet-holesky) branch. | ||
|
|
||
| ###### Core |
There was a problem hiding this comment.
minor: shall we just show how to get these from zeus?
|
|
||
| ### Current Mainnet Deployment | ||
|
|
||
| The current mainnet deployment is our M2 release. You can view the deployed contract addresses below, or check out the code itself on the [`mainnet`](https://github.com/Layr-Labs/eigenlayer-contracts/tree/mainnet) branch. |
There was a problem hiding this comment.
minor: users may not know what's m1 vs m2, prob just don't mention them?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
The previous README lacked organization and visual clarity, making it harder for users to quickly grasp the project's purpose and key details. Enhancing its structure and aesthetics improves accessibility and engagement.
Modifications:
Result:
A clearer, more structured, and visually engaging README that makes it easier for users and contributors to understand and navigate the project.
NOTE: Checkout the new README.