Skip to content

Commit 08c0c03

Browse files
rootulprootulp
authored
Merge pull request #832 from rootulp/rp/celestia-readme
Use Celestia specific README
2 parents 204597c + 5a03ba1 commit 08c0c03

File tree

1 file changed

+41
-129
lines changed

1 file changed

+41
-129
lines changed

‎README.md

Lines changed: 41 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -1,158 +1,70 @@
1-
# Tendermint
1+
# Celestia Core
22

3-
![banner](docs/tendermint-core-image.jpg)
3+
<!-- markdownlint-disable -->
4+
<img src="docs/celestia-logo.png">
5+
<!-- markdownlint-enable -->
46

5-
[Byzantine-Fault Tolerant](https://en.wikipedia.org/wiki/Byzantine_fault_tolerance)
6-
[State Machines](https://en.wikipedia.org/wiki/State_machine_replication).
7-
Or [Blockchain](<https://en.wikipedia.org/wiki/Blockchain_(database)>), for short.
7+
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/celestiaorg/celestia-core)
8+
[![Community](https://img.shields.io/badge/chat%20on-discord-orange?&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/YsnTPcSfWQ)
9+
[![license](https://img.shields.io/github/license/tendermint/tendermint.svg)](https://github.com/celestiaorg/celestia-core/blob/v0.35.x-celestia/LICENSE)
810

9-
[![version](https://img.shields.io/github/tag/tendermint/tendermint.svg)](https://github.com/tendermint/tendermint/releases/latest)
10-
[![API Reference](https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667)](https://pkg.go.dev/github.com/tendermint/tendermint)
11-
[![Go version](https://img.shields.io/badge/go-1.15-blue.svg)](https://github.com/moovweb/gvm)
12-
[![Discord chat](https://img.shields.io/discord/669268347736686612.svg)](https://discord.gg/AzefAFd)
13-
[![license](https://img.shields.io/github/license/tendermint/tendermint.svg)](https://github.com/tendermint/tendermint/blob/master/LICENSE)
14-
[![tendermint/tendermint](https://tokei.rs/b1/github/tendermint/tendermint?category=lines)](https://github.com/tendermint/tendermint)
15-
[![Sourcegraph](https://sourcegraph.com/github.com/tendermint/tendermint/-/badge.svg)](https://sourcegraph.com/github.com/tendermint/tendermint?badge)
11+
Celestia Core will power the Celestia main chain by leveraging Tendermint.
1612

17-
| Branch | Tests | Coverage | Linting |
18-
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
19-
| master | [![CircleCI](https://circleci.com/gh/tendermint/tendermint/tree/master.svg?style=shield)](https://circleci.com/gh/tendermint/tendermint/tree/master) </br> ![Tests](https://github.com/tendermint/tendermint/workflows/Tests/badge.svg?branch=master) | [![codecov](https://codecov.io/gh/tendermint/tendermint/branch/master/graph/badge.svg)](https://codecov.io/gh/tendermint/tendermint) | ![Lint](https://github.com/tendermint/tendermint/workflows/Lint/badge.svg) |
13+
Celestia itself is a scale-out data availability-focused minimal blockchain.
14+
It allows users to post arbitrary data on the chain, as well as define their own execution layers.
15+
This data is ordered on-chain but not executed. This allows for the first scalable data layer for
16+
decentralised applications, including optimistic rollup sidechains. Additionally, this design allows developers to
17+
define their own execution environments.
2018

21-
Tendermint Core is Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine - written in any programming language -
22-
and securely replicates it on many machines.
23-
24-
For protocol details, see [the specification](https://github.com/tendermint/spec).
25-
26-
For detailed analysis of the consensus protocol, including safety and liveness proofs,
27-
see our recent paper, "[The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938)".
28-
29-
## Releases
30-
31-
Please do not depend on master as your production branch. Use [releases](https://github.com/tendermint/tendermint/releases) instead.
32-
33-
Tendermint is being used in production in both private and public environments,
34-
most notably the blockchains of the [Cosmos Network](https://cosmos.network/).
35-
However, we are still making breaking changes to the protocol and the APIs and have not yet released v1.0.
36-
See below for more details about [versioning](#versioning).
37-
38-
In any case, if you intend to run Tendermint in production, we're happy to help. You can
39-
contact us [over email](mailto:hello@interchain.berlin) or [join the chat](https://discord.gg/AzefAFd).
40-
41-
## Security
42-
43-
To report a security vulnerability, see our [bug bounty
44-
program](https://hackerone.com/tendermint).
45-
For examples of the kinds of bugs we're looking for, see [our security policy](SECURITY.md)
46-
47-
We also maintain a dedicated mailing list for security updates. We will only ever use this mailing list
48-
to notify you of vulnerabilities and fixes in Tendermint Core. You can subscribe [here](http://eepurl.com/gZ5hQD).
49-
50-
## Minimum requirements
51-
52-
| Requirement | Notes |
53-
| ----------- | ---------------- |
54-
| Go version | Go1.15 or higher |
19+
Read this [blog post](https://blog.celestia.org/celestia-a-scalable-general-purpose-data-availability-layer-for-decentralized-apps-and-trust-minimized-sidechains/)
20+
to learn more about what we are building.
5521

5622
## Documentation
5723

58-
Complete documentation can be found on the [website](https://docs.tendermint.com/master/).
24+
The original [whitepaper](https://arxiv.org/abs/1905.09274) and the
25+
[specification](https://github.com/celestiaorg/celestia-specs) which we are currently wrapping up can give you
26+
a more detailed overview what to expect from this repository.
5927

60-
### Install
28+
### Minimum requirements
6129

62-
See the [install instructions](/docs/introduction/install.md).
63-
64-
### Quick Start
65-
66-
- [Single node](/docs/introduction/quick-start.md)
67-
- [Local cluster using docker-compose](/docs/networks/docker-compose.md)
68-
- [Remote cluster using Terraform and Ansible](/docs/networks/terraform-and-ansible.md)
69-
- [Join the Cosmos testnet](https://cosmos.network/testnet)
30+
| Requirement | Notes |
31+
|-------------|------------------|
32+
| Go version | Go1.17 or higher |
7033

7134
## Contributing
7235

73-
Please abide by the [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions.
74-
7536
Before contributing to the project, please take a look at the [contributing guidelines](CONTRIBUTING.md)
76-
and the [style guide](STYLE_GUIDE.md). You may also find it helpful to read the
77-
[specifications](https://github.com/tendermint/spec), watch the [Developer Sessions](/docs/DEV_SESSIONS.md),
78-
and familiarize yourself with our
79-
[Architectural Decision Records](https://github.com/tendermint/tendermint/tree/master/docs/architecture).
37+
and the [style guide](STYLE_GUIDE.md).
38+
39+
Join the community at [Telegram](https://t.me/CelestiaCommunity) or jump onto the [Forum](https://forum.celestia.org/)
40+
to get more involved into discussions.
41+
42+
Learn more by reading the code and the
43+
[specifications](https://github.com/celestiaorg/celestia-specs).
8044

8145
## Versioning
8246

8347
### Semantic Versioning
8448

85-
Tendermint uses [Semantic Versioning](http://semver.org/) to determine when and how the version changes.
49+
Celestia Core uses [Semantic Versioning](http://semver.org/) to determine when and how the version changes.
8650
According to SemVer, anything in the public API can change at any time before version 1.0.0
8751

88-
To provide some stability to Tendermint users in these 0.X.X days, the MINOR version is used
89-
to signal breaking changes across a subset of the total public API. This subset includes all
90-
interfaces exposed to other processes (cli, rpc, p2p, etc.), but does not
91-
include the Go APIs.
92-
93-
That said, breaking changes in the following packages will be documented in the
94-
CHANGELOG even if they don't lead to MINOR version bumps:
95-
96-
- crypto
97-
- config
98-
- libs
99-
- bech32
100-
- bits
101-
- bytes
102-
- json
103-
- log
104-
- math
105-
- net
106-
- os
107-
- protoio
108-
- rand
109-
- sync
110-
- strings
111-
- service
112-
- node
113-
- rpc/client
114-
- types
115-
116-
### Upgrades
117-
118-
In an effort to avoid accumulating technical debt prior to 1.0.0,
119-
we do not guarantee that breaking changes (ie. bumps in the MINOR version)
120-
will work with existing Tendermint blockchains. In these cases you will
121-
have to start a new blockchain, or write something custom to get the old
122-
data into the new chain. However, any bump in the PATCH version should be
123-
compatible with existing blockchain histories.
124-
125-
126-
For more information on upgrading, see [UPGRADING.md](./UPGRADING.md).
127-
128-
### Supported Versions
129-
130-
Because we are a small core team, we only ship patch updates, including security updates,
131-
to the most recent minor release and the second-most recent minor release. Consequently,
132-
we strongly recommend keeping Tendermint up-to-date. Upgrading instructions can be found
133-
in [UPGRADING.md](./UPGRADING.md).
134-
13552
## Resources
13653

137-
### Tendermint Core
138-
139-
For details about the blockchain data structures and the p2p protocols, see the
140-
[Tendermint specification](https://docs.tendermint.com/master/spec/).
54+
### Celestia (formerly LazyLedger)
14155

142-
For details on using the software, see the [documentation](/docs/) which is also
143-
hosted at: <https://docs.tendermint.com/master/>
56+
- [Ethereum research post](https://ethresear.ch/t/a-data-availability-blockchain-with-sub-linear-full-block-validation/5503)
57+
- [Academic paper](https://arxiv.org/abs/1905.09274)
58+
- [Blog](https://blog.celestia.org)
59+
- [Project web site](https://celestia.org)
60+
- [Academic prototype](https://github.com/celestiaorg/lazyledger-prototype)
61+
- [Follow Celestia on Twitter](https://twitter.com/CelestiaOrg)
14462

145-
### Tools
146-
147-
Benchmarking is provided by [`tm-load-test`](https://github.com/informalsystems/tm-load-test).
148-
Additional tooling can be found in [/docs/tools](/docs/tools).
149-
150-
### Applications
63+
### Tendermint Core
15164

152-
- [Cosmos SDK](http://github.com/cosmos/cosmos-sdk); a cryptocurrency application framework
153-
- [Ethermint](http://github.com/cosmos/ethermint); Ethereum on Tendermint
154-
- [Many more](https://tendermint.com/ecosystem)
65+
For more information on Tendermint Core and pointers to documentation for Tendermint visit
66+
this [repository](https://github.com/tendermint/tendermint).
15567

156-
### Research
68+
## Careers
15769

15870
We are hiring Go engineers! Join us in building the future of blockchain scaling and interoperability. [Apply here](https://jobs.lever.co/celestia).

0 commit comments

Comments
 (0)