ea677fcec7
* replace evmos.dev links with docs.evmos.org links * update open positions link * Update README.md Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com>
79 lines
3.2 KiB
Markdown
79 lines
3.2 KiB
Markdown
<!--
|
|
parent:
|
|
order: false
|
|
-->
|
|
|
|
<div align="center">
|
|
<h1> Ethermint </h1>
|
|
</div>
|
|
|
|
![banner](docs/ethermint.jpg)
|
|
|
|
<div align="center">
|
|
<a href="https://github.com/evmos/ethermint/releases/latest">
|
|
<img alt="Version" src="https://img.shields.io/github/tag/tharsis/ethermint.svg" />
|
|
</a>
|
|
<a href="https://github.com/evmos/ethermint/blob/main/LICENSE">
|
|
<img alt="License: Apache-2.0" src="https://img.shields.io/github/license/tharsis/ethermint.svg" />
|
|
</a>
|
|
<a href="https://pkg.go.dev/github.com/evmos/ethermint">
|
|
<img alt="GoDoc" src="https://godoc.org/github.com/evmos/ethermint?status.svg" />
|
|
</a>
|
|
<a href="https://goreportcard.com/report/github.com/evmos/ethermint">
|
|
<img alt="Go report card" src="https://goreportcard.com/badge/github.com/evmos/ethermint"/>
|
|
</a>
|
|
<a href="https://bestpractices.coreinfrastructure.org/projects/5018">
|
|
<img alt="Lines of code" src="https://img.shields.io/tokei/lines/github/tharsis/ethermint">
|
|
</a>
|
|
</div>
|
|
<div align="center">
|
|
<a href="https://discord.gg/trje9XuAmy">
|
|
<img alt="Discord" src="https://img.shields.io/discord/809048090249134080.svg" />
|
|
</a>
|
|
<a href="https://github.com/evmos/ethermint/actions?query=branch%3Amain+workflow%3ALint">
|
|
<img alt="Lint Status" src="https://github.com/evmos/ethermint/actions/workflows/lint.yml/badge.svg?branch=main" />
|
|
</a>
|
|
<a href="https://codecov.io/gh/tharsis/ethermint">
|
|
<img alt="Code Coverage" src="https://codecov.io/gh/tharsis/ethermint/branch/main/graph/badge.svg" />
|
|
</a>
|
|
</div>
|
|
|
|
Ethermint is a scalable and interoperable Ethereum library, built on Proof-of-Stake with fast-finality using the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/) which runs on top of [Tendermint Core](https://github.com/tendermint/tendermint) consensus engine.
|
|
|
|
**Note**: Requires [Go 1.19+](https://golang.org/dl/)
|
|
|
|
## Installation
|
|
|
|
For prerequisites and detailed build instructions please read the Evmos [Installation](https://docs.evmos.org/validators/quickstart/installation.html) instructions. Once the dependencies are installed, run:
|
|
|
|
```bash
|
|
make install
|
|
```
|
|
|
|
Or check out the latest [release](https://github.com/evmos/ethermint/releases).
|
|
|
|
## Quick Start
|
|
|
|
To learn how Ethermint works from a high-level perspective, go to the [Introduction](https://docs.evmos.org/about/intro/overview.html) section from the documentation. You can also check the instructions to [Run a Node](https://docs.evmos.org/validators/quickstart/run_node.html).
|
|
|
|
For an example on how Ethermint can be used on any Cosmos-SDK chain, please refer to [Evmos](https://www.github.com/tharsis/evmos).
|
|
|
|
## Community
|
|
|
|
The following chat channels and forums are a great spot to ask questions about Ethermint:
|
|
|
|
- [Evmos Twitter](https://twitter.com/EvmosOrg)
|
|
- [Evmos Discord](https://discord.gg/trje9XuAmy)
|
|
- [Evmos Telegram](https://t.me/EvmosOrg)
|
|
- [Tharsis Twitter](https://twitter.com/TharsisHQ)
|
|
|
|
## Contributing
|
|
|
|
Looking for a good place to start contributing? Check out some [`good first issues`](https://github.com/evmos/ethermint/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
|
|
|
|
For additional instructions, standards and style guides, please refer to the [Contributing](./CONTRIBUTING.md) document.
|
|
|
|
## Careers
|
|
|
|
See our open positions on [Greenhouse](https://boards.eu.greenhouse.io/evmos).
|