Skip to content

Commit

Permalink
docs: elaborate the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
mikebraver committed Feb 27, 2024
1 parent d2a758e commit 6c8024e
Showing 1 changed file with 21 additions and 29 deletions.
50 changes: 21 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,25 @@
<!--
parent:
order: false
-->
# exocore

Exocore is a scalable, high-throughput Proof-of-Stake blockchain
that is fully compatible and interoperable with Ethereum.
It's built using the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/)
which runs on top of the [Tendermint Core](https://github.com/tendermint/tendermint) consensus engine.

## Quick Start

To learn how Exocore works from a high-level perspective.

TBD
Exocore is an omnichain restaking protocol that combines the crypto-economic security from multiple blockchain networks and tokens, and extends it to any off-chain system. The protocol is designed with a modular architecture, incorporating Tendermint-based Byzantine Fault Tolerant (BFT) consensus mechanism, Zero-Knowledge (ZK) light-client bridging, and a fully EVM-compatible execution environment. This design enables smooth interactions for restakers and seamless integration for developers. Additionally, we introduce novel concepts, such as Union Restaking, where off-chain services can form a union to extend the crypto-economic security of their own tokens to each other. By pooling crypto-economic security and extending it to off-chain systems, Exocore powers an open market for decentralized trust.

## Documentation
TBD

## Installation
Once the dependencies are installed, run:

```bash
make install
```

Or check out the latest [release](https://github.com/Exocore/Exocore/releases).

## Community
TBD

## Contributing
TBD
To learn how Exocore works from a high-level perspective, see the [Exocore Whitepaper](https://t.co/A4y4YcOuEC)

## Creating docker images
1. Once the dependencies are installed, execute
`make localnet-init`, this will generate the cluster configuration file.
2. Run the following command to create the docker image:
```bash
make localnet-build
# Check if images build done
docker images
```
3. Launch the chain node:
```bash
make localnet-start
# Check if containers are all up
docker ps
```
## Interacting with a local node
With a node running, the exocored binary can be used to interact with the node. Run `./bin/exocored <command> --help` to get information about the available commands.

0 comments on commit 6c8024e

Please sign in to comment.