Skip to content

Commit 0d1040f

Browse files
authored
Make some improvements to the readme (#4998)
This PR fixes some random nits I had with the readme: * Add badges for python package version, license. * Use prettier discord badge & put it last. * Uncapitalize words after the first word in sections, for consistency. * Rename "in-development" to "unstable" for simplicity & consistency. * Remove unnecessary paragraph about additional specs. * Convert sentence about reference tests into bulleted list. * Use SSH link in cloning instructions. * Add license to pyproject.toml (to go with our new license badge). *Note*: The license badge will not work until our next release.
1 parent ee0a49c commit 0d1040f

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Ethereum Proof-of-Stake Consensus Specifications
22

3-
[![Join the chat at https://discord.gg/qGpsxSA](https://img.shields.io/badge/chat-on%20discord-blue.svg)](https://discord.gg/qGpsxSA)
43
[![nightly-tests](https://github.com/ethereum/consensus-specs/actions/workflows/nightly-tests.yml/badge.svg?branch=master&event=schedule)](https://github.com/ethereum/consensus-specs/actions/workflows/nightly-tests.yml)
4+
[![image](https://img.shields.io/pypi/v/eth-consensus-specs.svg)](https://pypi.python.org/pypi/eth-consensus-specs)
5+
[![image](https://img.shields.io/pypi/l/eth-consensus-specs.svg)](https://pypi.python.org/pypi/eth-consensus-specs)
6+
[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.gg/qGpsxSA)
57

68
This repository hosts the current Ethereum
79
[proof-of-stake](https://ethereum.org/en/developers/docs/consensus-mechanisms/pos/)
@@ -16,7 +18,7 @@ Core specifications for Ethereum proof-of-stake clients can be found in
1618
developed in parallel, and then consolidated into sequential upgrades when
1719
ready.
1820

19-
### Stable Specifications
21+
### Stable specifications
2022

2123
| Seq. | Code Name | Fork Epoch | Links |
2224
| ---- | ------------- | ---------- | --------------------------------------------------------------------------------------- |
@@ -28,7 +30,7 @@ ready.
2830
| 5 | **Electra** | `364032` | [Specs](specs/electra), [Tests](tests/core/pyspec/eth_consensus_specs/test/electra) |
2931
| 6 | **Fulu** | `411392` | [Specs](specs/fulu), [Tests](tests/core/pyspec/eth_consensus_specs/test/fulu) |
3032

31-
### In-development Specifications
33+
### Unstable specifications
3234

3335
| Seq. | Code Name | Fork Epoch | Links |
3436
| ---- | --------- | ---------- | ------------------------------------------------------------------------------- |
@@ -43,20 +45,17 @@ ready.
4345

4446
### External specifications
4547

46-
Additional specifications and standards outside of requisite client
47-
functionality can be found in the following repositories:
48-
4948
- [Beacon APIs](https://github.com/ethereum/beacon-apis)
5049
- [Engine APIs](https://github.com/ethereum/execution-apis/tree/main/src/engine)
5150
- [Beacon Metrics](https://github.com/ethereum/beacon-metrics)
5251
- [Builder Specs](https://github.com/ethereum/builder-specs)
5352

5453
### Reference tests
5554

56-
Stable reference tests are available as
57-
[release assets](https://github.com/ethereum/consensus-specs/releases) and
58-
unstable reference tests are available as
59-
[nightly builds](https://github.com/ethereum/consensus-specs/actions/workflows/nightly-tests.yml).
55+
- Stable reference tests are available as
56+
[release assets](https://github.com/ethereum/consensus-specs/releases).
57+
- Unstable reference tests are available as
58+
[nightly builds](https://github.com/ethereum/consensus-specs/actions/workflows/nightly-tests.yml).
6059

6160
## Contributors
6261

@@ -73,7 +72,7 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
7372
Clone the repository with:
7473

7574
```
76-
git clone https://github.com/ethereum/consensus-specs.git
75+
git clone git@github.com:ethereum/consensus-specs.git
7776
```
7877

7978
Switch to the directory:

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ name = "eth-consensus-specs"
66
dynamic = ["version"]
77
authors = [{ name = "ethereum" }]
88
description = "Ethereum consensus layer specifications package"
9+
license = "CC0-1.0"
910
readme = { file = "README.md", content-type = "text/markdown" }
1011
requires-python = ">=3.11, <3.15"
1112
urls = { homepage = "https://github.com/ethereum/consensus-specs" }

0 commit comments

Comments
 (0)