Skip to content

Commit

Permalink
Update README: Add friendlier introduction (#5927)
Browse files Browse the repository at this point in the history
* Update README: Add friendlier introduction

* Apply suggestions from code review

Co-authored-by: lightclient <[email protected]>

* Readd 5069

* Remove trailing space

* Apply suggestions from code review

Co-authored-by: lightclient <[email protected]>
Co-authored-by: Sam Wilson <[email protected]>
  • Loading branch information
3 people authored Jan 25, 2023
1 parent d005d7c commit d65ccef
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
# Ethereum Improvement Proposals (EIPs)

**Before you initiate a pull request**, please read the [EIP-1](https://eips.ethereum.org/EIPS/eip-1) process document. Ideas should be thoroughly discussed on [Ethereum Research](https://ethresear.ch/t/read-this-before-posting/8) or [Ethereum Magicians](https://ethereum-magicians.org/) first.
The goal of the EIP project is to standardize and provide high-quality documentation for Ethereum itself and conventions built upon it. This repository tracks past and ongoing improvements to Ethereum in the form of Ethereum Improvement Proposals (EIPs). [EIP-1](https://eips.ethereum.org/EIPS/eip-1) governs how EIPs are published.

This repository tracks ongoing improvements to Ethereum. It contains:
The [status page](https://eips.ethereum.org/) tracks and lists EIPs, which can be divided into the following categories:

- The [EIP status page](https://eips.ethereum.org), tracking protocols for Ethereum clients and applications
- The [process document](https://eips.ethereum.org/EIPS/eip-1) that governs how protocols are published here
- [Core EIPs](https://eips.ethereum.org/core) are improvements to the Ethereum consensus protocol.
- [Networking EIPs](https://eips.ethereum.org/networking) specify the peer-to-peer networking layer of Ethereum.
- [Interface EIPs](https://eips.ethereum.org/interface) standardize interfaces to Ethereum, which determine how users and applications interact with the blockchain.
- [ERCs](https://eips.ethereum.org/erc) specify application layer standards, which determine how applications running on Ethereum can interact with each other.
- [Meta EIPs](https://eips.ethereum.org/meta) are miscellaneous improvements that nonetheless require some sort of consensus.
- [Informational EIPs](https://eips.ethereum.org/informational) are non-standard improvements that do not require any form of consensus.

For help *implementing* an EIP, please visit [Ethereum Stack Exchange](https://ethereum.stackexchange.com).
**Before you write an EIP, ideas MUST be thoroughly discussed on [Ethereum Magicians](https://ethereum-magicians.org/) or [Ethereum Research](https://ethresear.ch/t/read-this-before-posting/8). Once consensus is reached, thoroughly read and review [EIP-1](https://eips.ethereum.org/EIPS/eip-1), which describes the EIP process.**

If you would like to become an EIP Editor, please check [EIP-5069](./EIPS/eip-5069.md).
Please note that this repository is for documenting standards and not for help implementing them. These types of inquiries should be directed to the [Ethereum Stack Exchange](https://ethereum.stackexchange.com). For specific questions and concerns regarding EIPs, it's best to comment on the relevant discussion thread of the EIP denoted by the `discussions-to` tag in the EIP's preamble.

## Mission

The goal of the EIP project is to document standardized protocols for Ethereum clients and applications and to document them in a high-quality and implementable way.
If you would like to become an EIP Editor, please read [EIP-5069](./EIPS/eip-5069.md).

## Preferred Citation Format

Expand Down

0 comments on commit d65ccef

Please sign in to comment.