From 0cdedfc1fd465c292504966a7833e8d2e8028c67 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Federico=20Kunze=20K=C3=BCllmer?=
 <31522760+fedekunze@users.noreply.github.com>
Date: Thu, 26 Aug 2021 14:06:44 -0400
Subject: [PATCH] docs: update `README.md` (#503)

* readme: update

* install

* typo
---
 .github/workflows/lint.yml      |  2 +-
 README.md                       | 49 +++++++++++++++++++++++++--------
 docs/quickstart/installation.md |  7 +++--
 3 files changed, 42 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index efe75874..ad53bee4 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -1,4 +1,4 @@
-name: Run Lint
+name: Lint
 # 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
 # running if no *.{go, mod, sum} files have been changed.
diff --git a/README.md b/README.md
index d0ad652f..376ccc1e 100644
--- a/README.md
+++ b/README.md
@@ -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,18 +27,21 @@ 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
@@ -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/)
 
+## 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:careers@thars.is) via email.
diff --git a/docs/quickstart/installation.md b/docs/quickstart/installation.md
index 0cd8cd98..3ce3a981 100644
--- a/docs/quickstart/installation.md
+++ b/docs/quickstart/installation.md
@@ -4,11 +4,12 @@ order: 1
 
 # Installation
 
+Build and install the Ethermint binaries from source or using Docker. {synopsis}
+
 ## Pre-requisites
 
-### Install [`jq`](https://stedolan.github.io/jq)
-
-On Mac `brew install jq` or download the official binaries on the project [website](https://stedolan.github.io/jq/download/).
+- [Install Go 1.16+](https://golang.org/dl/) {prereq}
+- [Install jq](https://stedolan.github.io/jq/download/) {prereq}
 
 ## Install Binaries