diff --git a/README.md b/README.md index 9056750ea..1e4159a19 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ # Tendermint Spec -This repository contains specs of the current and future implementation of Tendermint the protocol, papers that have been published by the ICF or AIB and ongoing research in a variety of areas. -- For the pdf, see the [latest release](https://github.com/tendermint/spec/releases). +This repository contains specifications for the Tendermint protocol. For the pdf, see the [latest release](https://github.com/tendermint/spec/releases). + +There are currently two implementations of the Tendermint protocol, +maintained by two separate-but-collaborative entities: +One in [Go](https://github.com/tendermint/tendermint), +maintained by Interchain GmbH, +and one in [Rust](https://github.com/informalsystems/tendermint-rs), +maintained by Informal Systems. + +There have been inadvertent divergences in the specs followed +by the Go implementation and the Rust implementation respectively. +However, we are worked to reconverge these specs into a single unified spec. +Consequently, this repository is in a bit of a state of flux. + +At the moment, the spec followed by the Go implementation +(tendermint/tendermint) is in the [spec](spec) directory, +while the spec followed by the Rust implementation +(informalsystems/tendermint-rs) is in the rust-spec +directory. TLA+ specifications are also in the rust-spec directory. + +Over time, these specs will converge in the spec directory. +Once they have fully converged, we will version the spec moving forward. \ No newline at end of file diff --git a/papers/README.md b/papers/README.md deleted file mode 100644 index dd8835681..000000000 --- a/papers/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Papers - -This folder houses Papers that have either been published or are a work in progress. - -## Table of Contents diff --git a/research/README.md b/research/README.md deleted file mode 100644 index dcb51a4bc..000000000 --- a/research/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Research - -This folder holds ongoing research and topics of interest. The [Interchain Foundation](https://interchain.io) has research topics that they are willing fund the research for, to find out more you can go to there [funding repo](https://github.com/interchainio/funding/blob/master/research.md). - -You can apply for a research grant [here](https://docs.google.com/forms/d/e/1FAIpQLSclH4R5G7WgNpKPvXxPPFRA7rAoyX8nNvsJAQJpZNZwWWjFmA/viewform)