From 5c3440623954917635c7ee8dffdde45530e0cd79 Mon Sep 17 00:00:00 2001 From: Justin Traglia Date: Wed, 29 Jan 2025 21:54:22 -0600 Subject: [PATCH 1/2] Remove outdated specs section from readme --- README.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/README.md b/README.md index 5749a89506..6c37151b11 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,6 @@ Features are researched and developed in parallel, and then consolidated into se | 5 | **Electra** | TBD | | | 6 | **Fulu** | TBD | | -### Outdated Specifications - -| Code Name or Topic | Specs | Notes | -| - | - | - | -| Sharding | | -| Custody Game | | Dependent on sharding | -| Data Availability Sampling | | | - ### Accompanying documents can be found in [specs](specs) and include: * [SimpleSerialize (SSZ) spec](ssz/simple-serialize.md) From 10adcdbb7a517c4e4663a9051555f210b45ef435 Mon Sep 17 00:00:00 2001 From: Justin Traglia Date: Wed, 29 Jan 2025 21:58:27 -0600 Subject: [PATCH 2/2] Fix little nits in the readme --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6c37151b11..b823d82ae2 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ To learn more about proof-of-stake and sharding, see the [PoS documentation](htt This repository hosts the current Ethereum proof-of-stake specifications. Discussions about design rationale and proposed changes can be brought up and discussed as issues. Solidified, agreed-upon changes to the spec can be made through pull requests. -## Specs +## Specifications [![GitHub release](https://img.shields.io/github/v/release/ethereum/consensus-specs)](https://github.com/ethereum/consensus-specs/releases/) [![PyPI version](https://badge.fury.io/py/eth2spec.svg)](https://badge.fury.io/py/eth2spec) [![testgen](https://github.com/ethereum/consensus-specs/actions/workflows/generate_vectors.yml/badge.svg?branch=dev&event=schedule)](https://github.com/ethereum/consensus-specs/actions/workflows/generate_vectors.yml) -Core specifications for Ethereum proof-of-stake clients can be found in [specs](./specs). These are divided into features. +Core specifications for Ethereum proof-of-stake clients can be found in [specs](specs). These are divided into features. Features are researched and developed in parallel, and then consolidated into sequential upgrades when ready. ### Stable Specifications @@ -42,7 +42,7 @@ Additional specifications and standards outside of requisite client functionalit * [Beacon APIs](https://github.com/ethereum/beacon-apis) * [Engine APIs](https://github.com/ethereum/execution-apis/tree/main/src/engine) -* [Beacon Metrics](https://github.com/ethereum/beacon-metrics/) +* [Beacon Metrics](https://github.com/ethereum/beacon-metrics) ## Design goals @@ -73,7 +73,8 @@ Documentation on the different components used during spec writing can be found Conformance tests built from the executable python spec are available in the [Ethereum Proof-of-Stake Consensus Spec Tests](https://github.com/ethereum/consensus-spec-tests) repo. Compressed tarballs are available in [releases](https://github.com/ethereum/consensus-spec-tests/releases). -## Installation and Usage +## Installation and usage + The consensus-specs repo can be used by running the tests locally or inside a docker container. To run the tests locally: