This repository has been archived by the owner on Apr 4, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 569
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* readme: update * install * typo
- Loading branch information
Showing
3 changed files
with
42 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,7 +16,7 @@ parent: | |
<a href="https://github.com/tharsis/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/tharsis/ethermint?tab=doc"> | ||
<a href="https://pkg.go.dev/github.com/tharsis/ethermint"> | ||
<img alt="GoDoc" src="https://godoc.org/github.com/tharsis/ethermint?status.svg" /> | ||
</a> | ||
<a href="https://goreportcard.com/report/github.com/tharsis/ethermint"> | ||
|
@@ -27,34 +27,59 @@ parent: | |
</a> | ||
</div> | ||
<div align="center"> | ||
<a href="https://discord.gg/AzefAFd"> | ||
<img alt="Discord" src="https://img.shields.io/discord/669268347736686612.svg" /> | ||
<a href="https://discord.gg/3ZbxEq4KDu"> | ||
<img alt="Discord" src="https://img.shields.io/discord/809048090249134080.svg" /> | ||
</a> | ||
<a href="https://github.com/tharsis/ethermint/actions?query=workflow%3ABuild"> | ||
<img alt="Build Status" src="https://github.com/tharsis/ethermint/workflows/Build/badge.svg" /> | ||
</a> | ||
<a href="https://github.com/tharsis/ethermint/actions?query=workflow%3ALint"> | ||
<img alt="Lint Status" src="https://github.com/tharsis/ethermint/workflows/Lint/badge.svg" /> | ||
<!-- <a href="https://github.com/tharsis/ethermint/actions?query=branch%3Amain+workflow%3ABuild"> | ||
<img alt="Build Status" src="https://github.com/tharsis/ethermint/actions/workflows/build.yml/badge.svg?branch=main" /> | ||
</a> --> | ||
<a href="https://github.com/tharsis/ethermint/actions?query=branch%3Amain+workflow%3ALint"> | ||
<img alt="Lint Status" src="https://github.com/tharsis/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> | ||
<a href="https://twitter.com/ethermint"> | ||
<img alt="Twitter Follow Ethermint" src="https://img.shields.io/twitter/follow/ethermint"/> | ||
</a> | ||
</div> | ||
|
||
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. | ||
|
||
**Note**: Requires [Go 1.16+](https://golang.org/dl/) | ||
|
||
## Installation | ||
|
||
For prerequisites and detailed build instructions please read the [Installation](https://ethermint.dev/quickstart/installation.html) instructions. Once the dependencies are installed, run: | ||
|
||
```bash | ||
make install | ||
``` | ||
|
||
Or check out the latest [release](https://github.com/tharsis/ethermint/releases). | ||
|
||
## Quick Start | ||
|
||
To learn how the Ethermint works from a high-level perspective, go to the [Introduction](./docs/intro/overview.md) section from the documentation. | ||
To learn how the Ethermint works from a high-level perspective, go to the [Introduction](https://ethermint.dev/intro/overview.html) section from the documentation. You can also check the instructions to [Run a Node](https://ethermint.dev/quickstart/run_node.html). | ||
|
||
For more, please refer to the [Ethermint Docs](./docs/), which are also hosted on [ethermint.dev](https://ethermint.dev/). | ||
|
||
### Community | ||
## Community | ||
|
||
The following chat channels and forums are a great spot to ask questions about Ethermint: | ||
|
||
- [Cosmos Discord](https://discord.gg/W8trcGV) | ||
- [Cosmos Forum](https://forum.cosmos.network) | ||
- [Ethermint Twitter](https://twitter.com/ethermint) | ||
- [Tharsis Twitter](https://twitter.com/ethermint) | ||
- [Ethermint Discord](https://discord.gg/3ZbxEq4KDu) | ||
- [Ethermint Forum](https://forum.cosmos.network/c/ethermint) | ||
|
||
## Contributing | ||
|
||
Looking for a good place to start contributing? Check out some [`good first issues`](https://github.com/tharsis/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 [Cosmos Jobs](https://jobs.cosmos.network/project/ethermint-d0sk1uxuh-remote/), [Notion](https://tharsis.notion.site/Jobs-at-Tharsis-5a1642eb89b34747ae6f2db2d356fc0d), or feel free to [reach out](mailto:[email protected]) via email. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters