Skip to content

Commit

Permalink
docs: readme (#12)
Browse files Browse the repository at this point in the history
* docs: readme

* update
  • Loading branch information
ranupthestairs committed Sep 30, 2021
1 parent 9b14a30 commit 5a517d4
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 22 deletions.
58 changes: 40 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,54 +7,76 @@ parent:
<h1> Evmos </h1>
</div>

<!-- TODO: add banner -->
<!-- ![banner](docs/ethermint.jpg) -->

<div align="center">
<a href="https://github.com/tharsis/evmos/releases/latest">
<img alt="Version" src="https://img.shields.io/github/tag/tharsis/evmos.svg" />
</a>
<a href="https://github.com/tharsis/evmos/blob/main/LICENSE">
<img alt="License: Apache-2.0" src="https://img.shields.io/github/license/tharsis/evmos.svg" />
</a>
<a href="https://pkg.go.dev/github.com/tharsis/evmos?tab=doc">
<a href="https://pkg.go.dev/github.com/tharsis/evmos">
<img alt="GoDoc" src="https://godoc.org/github.com/tharsis/evmos?status.svg" />
</a>
<a href="https://goreportcard.com/report/github.com/tharsis/evmos">
<img alt="Go report card" src="https://goreportcard.com/badge/github.com/tharsis/evmos"/>
</a>
<a href="https://bestpractices.coreinfrastructure.org/projects/5018">
<img src="https://bestpractices.coreinfrastructure.org/projects/5018/badge">
<img alt="Lines of code" src="https://img.shields.io/tokei/lines/github/tharsis/evmos">
</a>
</div>
<div align="center">
<a href="https://discord.gg/AzefAFd">
<img alt="Discord" src="https://img.shields.io/discord/669268347736686612.svg" />
</a>
<a href="https://github.com/tharsis/evmos/actions?query=workflow%3ABuild">
<img alt="Build Status" src="https://github.com/tharsis/evmos/workflows/Build/badge.svg" />
<a href="https://discord.gg/trje9XuAmy">
<img alt="Discord" src="https://img.shields.io/discord/809048090249134080.svg" />
</a>
<a href="https://github.com/tharsis/evmos/actions?query=workflow%3ALint">
<img alt="Lint Status" src="https://github.com/tharsis/evmos/workflows/Lint/badge.svg" />
<a href="https://github.com/tharsis/evmos/actions?query=branch%3Amain+workflow%3ALint">
<img alt="Lint Status" src="https://github.com/tharsis/evmos/actions/workflows/lint.yml/badge.svg?branch=main" />
</a>
<a href="https://codecov.io/gh/tharsis/evmos">
<img alt="Code Coverage" src="https://codecov.io/gh/tharsis/evmos/branch/main/graph/badge.svg?token=6peOasOSxP" />
<img alt="Code Coverage" src="https://codecov.io/gh/tharsis/evmos/branch/main/graph/badge.svg" />
</a>
<!-- TODO: add -->
<!-- <a href="https://twitter.com/evmos">
<img alt="Twitter Follow Evmos" src="https://img.shields.io/twitter/follow/evmos"/>
</a> -->
</div>

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:[email protected]) via email.
4 changes: 0 additions & 4 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -269,10 +269,6 @@ module.exports = {
"label": "main",
"key": "main"
},
{
"label": "v0.5",
"key": "v0.5"
}
],
}
};

0 comments on commit 5a517d4

Please sign in to comment.