docs: update README.md (#503)

* readme: update

* install

* typo
This commit is contained in:
Federico Kunze Küllmer 2021-08-26 14:06:44 -04:00 committed by GitHub
parent 7389770b10
commit 0cdedfc1fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 42 additions and 16 deletions

View File

@ -1,4 +1,4 @@
name: Run Lint name: Lint
# Lint runs golangci-lint over the entire ethermint repository This workflow is # Lint runs golangci-lint over the entire ethermint repository This workflow is
# run on every pull request and push to main The `golangci` will pass without # run on every pull request and push to main The `golangci` will pass without
# running if no *.{go, mod, sum} files have been changed. # running if no *.{go, mod, sum} files have been changed.

View File

@ -16,7 +16,7 @@ parent:
<a href="https://github.com/tharsis/ethermint/blob/main/LICENSE"> <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" /> <img alt="License: Apache-2.0" src="https://img.shields.io/github/license/tharsis/ethermint.svg" />
</a> </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" /> <img alt="GoDoc" src="https://godoc.org/github.com/tharsis/ethermint?status.svg" />
</a> </a>
<a href="https://goreportcard.com/report/github.com/tharsis/ethermint"> <a href="https://goreportcard.com/report/github.com/tharsis/ethermint">
@ -27,18 +27,21 @@ parent:
</a> </a>
</div> </div>
<div align="center"> <div align="center">
<a href="https://discord.gg/AzefAFd"> <a href="https://discord.gg/3ZbxEq4KDu">
<img alt="Discord" src="https://img.shields.io/discord/669268347736686612.svg" /> <img alt="Discord" src="https://img.shields.io/discord/809048090249134080.svg" />
</a> </a>
<a href="https://github.com/tharsis/ethermint/actions?query=workflow%3ABuild"> <!-- <a href="https://github.com/tharsis/ethermint/actions?query=branch%3Amain+workflow%3ABuild">
<img alt="Build Status" src="https://github.com/tharsis/ethermint/workflows/Build/badge.svg" /> <img alt="Build Status" src="https://github.com/tharsis/ethermint/actions/workflows/build.yml/badge.svg?branch=main" />
</a> </a> -->
<a href="https://github.com/tharsis/ethermint/actions?query=workflow%3ALint"> <a href="https://github.com/tharsis/ethermint/actions?query=branch%3Amain+workflow%3ALint">
<img alt="Lint Status" src="https://github.com/tharsis/ethermint/workflows/Lint/badge.svg" /> <img alt="Lint Status" src="https://github.com/tharsis/ethermint/actions/workflows/lint.yml/badge.svg?branch=main" />
</a> </a>
<a href="https://codecov.io/gh/tharsis/ethermint"> <a href="https://codecov.io/gh/tharsis/ethermint">
<img alt="Code Coverage" src="https://codecov.io/gh/tharsis/ethermint/branch/main/graph/badge.svg" /> <img alt="Code Coverage" src="https://codecov.io/gh/tharsis/ethermint/branch/main/graph/badge.svg" />
</a> </a>
<a href="https://twitter.com/ethermint">
<img alt="Twitter Follow Ethermint" src="https://img.shields.io/twitter/follow/ethermint"/>
</a>
</div> </div>
Ethermint is a scalable, high-throughput Proof-of-Stake blockchain that is fully compatible and Ethermint is a scalable, high-throughput Proof-of-Stake blockchain that is fully compatible and
@ -46,15 +49,37 @@ interoperable with Ethereum. It's build using the the [Cosmos SDK](https://githu
**Note**: Requires [Go 1.16+](https://golang.org/dl/) **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 ## 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/). 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: The following chat channels and forums are a great spot to ask questions about Ethermint:
- [Cosmos Discord](https://discord.gg/W8trcGV) - [Ethermint Twitter](https://twitter.com/ethermint)
- [Cosmos Forum](https://forum.cosmos.network) - [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:careers@thars.is) via email.

View File

@ -4,11 +4,12 @@ order: 1
# Installation # Installation
Build and install the Ethermint binaries from source or using Docker. {synopsis}
## Pre-requisites ## Pre-requisites
### Install [`jq`](https://stedolan.github.io/jq) - [Install Go 1.16+](https://golang.org/dl/) {prereq}
- [Install jq](https://stedolan.github.io/jq/download/) {prereq}
On Mac `brew install jq` or download the official binaries on the project [website](https://stedolan.github.io/jq/download/).
## Install Binaries ## Install Binaries