docs: README, contributor guidelines (#466)

* contributor guidelines

* notes

* README
This commit is contained in:
Federico Kunze Küllmer
2021-08-20 15:38:03 +00:00
committed by GitHub
parent 9ea2ce4b8f
commit 0d06ade374
6 changed files with 711 additions and 162 deletions
+3 -3
View File
@@ -7,6 +7,8 @@ parent:
<h1> Ethermint </h1>
</div>
![banner](docs/ethermint.jpg)
<div align="center">
<a href="https://github.com/tharsis/ethermint/releases/latest">
<img alt="Version" src="https://img.shields.io/github/tag/tharsis/ethermint.svg" />
@@ -42,9 +44,7 @@ parent:
Ethermint is a scalable, high-throughput Proof-of-Stake blockchain that is fully compatible and
interoperable with Ethereum. It's build using the the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/) which runs on top of [Tendermint Core](https://github.com/tendermint/tendermint) consensus engine.
> **WARNING:** Ethermint is under VERY ACTIVE DEVELOPMENT and should be treated as pre-alpha software. This means it is not meant to be run in production, its APIs are subject to change without warning and should not be relied upon, and it should not be used to hold any value. We will remove this warning when we have a release that is stable, secure, and properly tested.
**Note**: Requires [Go 1.15+](https://golang.org/dl/)
**Note**: Requires [Go 1.16+](https://golang.org/dl/)
## Quick Start