diff --git a/README.md b/README.md index 0403089..49e32f0 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,9 @@ parent:

Evmos

+ + +
Version @@ -14,47 +17,66 @@ parent: License: Apache-2.0 - + GoDoc Go report card - + Lines of code
- - Discord - - - Build Status + + Discord - - Lint Status + + Lint Status - Code Coverage + Code Coverage + +
Evmos 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:** Evmos 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.17+](https://golang.org/dl/) -## Quick Start +## Installation -To learn how the Evmos works from a high-level perspective, go to the [Introduction](./docs/intro/overview.md) section from the documentation. +For prerequisites and detailed build instructions please read the [Installation](https://evmos.dev/quickstart/installation.html) instructions. Once the dependencies are installed, run: -For more, please refer to the [Evmos Docs](./docs/). +```bash +make install +``` + +Or check out the latest [release](https://github.com/tharsis/evmos/releases). + +## Quick Start -### Community +To learn how the Evmos works from a high-level perspective, go to the [Introduction](https://evmos.dev/intro/overview.html) section from the documentation. You can also check the instructions to [Run a Node](https://evmos.dev/quickstart/run_node.html). + +## Community The following chat channels and forums are a great spot to ask questions about Evmos: -- [Cosmos Discord](https://discord.gg/W8trcGV) -- [Cosmos Forum](https://forum.cosmos.network) +- [Evmos Twitter](https://twitter.com/evmos) +- [Evmos Discord](https://discord.gg/trje9XuAmy) +- [Evmos Forum](https://forum.cosmos.network/c/ethermint) +- [Tharsis Twitter](https://twitter.com/TharsisHQ) + +## Contributing + +Looking for a good place to start contributing? Check out some [`good first issues`](https://github.com/tharsis/evmos/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/evmos-d0sk1uxuh-remote/), [Notion](https://tharsis.notion.site), or feel free to [reach out](mailto:careers@thars.is) via email. diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index fa82ae4..48d61d5 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -269,10 +269,6 @@ module.exports = { "label": "main", "key": "main" }, - { - "label": "v0.5", - "key": "v0.5" - } ], } }; \ No newline at end of file