Skip to content

Commit fdd4f0a

Browse files
authored
docs: bump deployment matrix to top of README (#1376)
**Motivation:** bump deployment matrix to top of README for better readibility
1 parent 0c182e5 commit fdd4f0a

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,6 @@
55
EigenLayer is a set of smart contracts deployed on Ethereum that enable restaking of assets to secure new services (AVSs).
66

77

8-
## Get Started
9-
10-
See [CONTRIBUTING](CONTRIBUTING.md).
11-
12-
Contributions that do not follow our fork base PR practices will be either rejected or immediately deleted based on your role, preventing branch pollution, keeping our repository clean, make it more readable and searchable.
13-
14-
15-
## Branching
16-
17-
Branches we use:
18-
* `main`: The canonical, most up-to-date branch, containing the work-in-progress code for upcoming releases
19-
* `Vx.y.z`: Release branch with version `x.y.z` that matches a release of EigenLayer, release branch is always cut from `main` via cherry-picking
20-
* `release-dev/xxx`: A development branch for a large feature to be released, the branch should eventually be deleted after merge to `main`
21-
22-
23-
## Documentation
24-
25-
### Basics
26-
27-
To get a basic understanding of EigenLayer, check out [You Could've Invented EigenLayer](https://www.blog.eigenlayer.xyz/ycie/). Note that some of the document's content describes features that do not exist yet (like the Slasher). To understand more about how restakers and operators interact with EigenLayer, check out these guides:
28-
* [Restaking User Guide](https://docs.eigenlayer.xyz/eigenlayer/restaking-guides/overview)
29-
* [Operator Guide](https://docs.eigenlayer.xyz/operator-guides/operator-introduction)
30-
31-
### Deep Dive
32-
33-
The most up-to-date and technical documentation can be found in [/docs](/docs). If you're a shadowy super coder, this is a great place to get an overview of the contracts before diving into the code.
34-
35-
To get an idea of how users interact with these contracts, check out our integration tests: [/src/test/integration](./src/test/integration/).
36-
37-
38-
398
## Deployments
409

4110
### Deployment Version By Environments
@@ -270,3 +239,34 @@ The following strategies differ significantly from the other strategies deployed
270239
| [`OZ: Proxy Admin`](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.7.1/contracts/proxy/transparent/ProxyAdmin.sol) | - | [`0x56E8...6Fa1`](https://sepolia.etherscan.io/address/0x56E88cb4f0136fC27D95499dE4BE2acf47946Fa1) | |
271240

272241
</details>
242+
243+
244+
## Get Started
245+
246+
See [CONTRIBUTING](CONTRIBUTING.md).
247+
248+
Contributions that do not follow our fork base PR practices will be either rejected or immediately deleted based on your role, preventing branch pollution, keeping our repository clean, make it more readable and searchable.
249+
250+
251+
## Branching
252+
253+
Branches we use:
254+
* `main`: The canonical, most up-to-date branch, containing the work-in-progress code for upcoming releases
255+
* `Vx.y.z`: Release branch with version `x.y.z` that matches a release of EigenLayer, release branch is always cut from `main` via cherry-picking
256+
* `release-dev/xxx`: A development branch for a large feature to be released, the branch should eventually be deleted after merge to `main`
257+
258+
259+
## Documentation
260+
261+
### Basics
262+
263+
To get a basic understanding of EigenLayer, check out [You Could've Invented EigenLayer](https://www.blog.eigenlayer.xyz/ycie/). Note that some of the document's content describes features that do not exist yet (like the Slasher). To understand more about how restakers and operators interact with EigenLayer, check out these guides:
264+
* [Restaking User Guide](https://docs.eigenlayer.xyz/eigenlayer/restaking-guides/overview)
265+
* [Operator Guide](https://docs.eigenlayer.xyz/operator-guides/operator-introduction)
266+
267+
### Deep Dive
268+
269+
The most up-to-date and technical documentation can be found in [/docs](/docs). If you're a shadowy super coder, this is a great place to get an overview of the contracts before diving into the code.
270+
271+
To get an idea of how users interact with these contracts, check out our integration tests: [/src/test/integration](./src/test/integration/).
272+

0 commit comments

Comments
 (0)