From 6c8024ee4b3f81428c0be3523210efccde4ee67c Mon Sep 17 00:00:00 2001 From: mikebraver <142298428+mikebraver@users.noreply.github.com> Date: Tue, 27 Feb 2024 15:15:38 +0800 Subject: [PATCH] docs: elaborate the README file --- README.md | 50 +++++++++++++++++++++----------------------------- 1 file changed, 21 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 0243b8f64..0bf8301c0 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,25 @@ - +# 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 \ No newline at end of file +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 --help` to get information about the available commands. \ No newline at end of file