Skip to content

Commit

Permalink
docs: README, contributor guidelines (#466)
Browse files Browse the repository at this point in the history
* contributor guidelines

* notes

* README
  • Loading branch information
fedekunze authored Aug 20, 2021
1 parent 9ea2ce4 commit 0d06ade
Show file tree
Hide file tree
Showing 6 changed files with 727 additions and 178 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CODEOWNERS: https://help.github.com/articles/about-codeowners/

# Primary repo maintainers
* @fedekunze @khoslaventures
* @fedekunze @khoslaventures @nzoghb
546 changes: 373 additions & 173 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,10 @@ localnet-show-logstream:

.PHONY: build-docker-local-ethermint localnet-start localnet-stop

# release
###############################################################################
### Releasing ###
###############################################################################

PACKAGE_NAME:=github.com/tharsis/ethermint
GOLANG_CROSS_VERSION = v1.16.4
release-dry-run:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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

Expand Down
Binary file added docs/ethermint.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 0d06ade

Please sign in to comment.