From 6e6b64a61ba6f6f83e52da5f07937a0dbc3941bf Mon Sep 17 00:00:00 2001
From: Uncle Fatso <uncle.fatso@ghostchain.io>
Date: Wed, 23 Jul 2025 22:26:52 +0300
Subject: [PATCH] add information to the readme

Signed-off-by: Uncle Fatso <uncle.fatso@ghostchain.io>
---
 README.md | 117 +++++++++++++++++++++++++++---------------------------
 1 file changed, 59 insertions(+), 58 deletions(-)

diff --git a/README.md b/README.md
index 9265b45..79cb183 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,63 @@
-## Foundry
+## Ghost DAO protocol
 
-**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
+[ghostDAO](https://app.dao.ghostchain.io/) is a decentralized multi-chain reserve currency protocol. ghostDAO protocol is powered by [GHOST native blockchain](https://ghostchain.io/) enabling anonymous cross-chain transactions of GHST. Each eGHST token is backed by a basket of stablecoins in the ghostDAO treasury, giving it an intrinsic value that it cannot fall below.
+
+## Usage
+
+You need to install [foundry](https://getfoundry.sh/) or use contracts from `/src` folder with any tool you are comfortable with.
+
+### Clone
+
+```shell
+git clone https://git.ghostchain.io/ghostchain/ghost-dao-contracts.git
+```
+
+### Foundry preparation
+
+```shell
+git submodule init
+git submodule update
+forge soldeer install
+```
+
+### Build contracts
+
+```shell
+$ forge build
+```
+
+### Test contracts
+
+```shell
+$ forge test
+```
+
+### Environment
+
+```shell
+$ cp .env.template .env
+# populate the .env file with specific values for environment variables
+```
+
+### Local deployment
+
+```shell
+# in first terminal
+$ anvil
+
+# in second terminal
+$ ./deployer.sh --network anvil-localnet
+```
+
+### Deployer help
+
+```shell
+$ ./deployer.sh --help
+```
+
+## Technologies Used
+
+[Foundry](https://getfoundry.sh/) is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.
 
 Foundry consists of:
 
@@ -8,59 +65,3 @@ Foundry consists of:
 -   **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
 -   **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
 -   **Chisel**: Fast, utilitarian, and verbose solidity REPL.
-
-## Documentation
-
-https://book.getfoundry.sh/
-
-## Usage
-
-### Build
-
-```shell
-$ forge build
-```
-
-### Test
-
-```shell
-$ forge test
-```
-
-### Format
-
-```shell
-$ forge fmt
-```
-
-### Gas Snapshots
-
-```shell
-$ forge snapshot
-```
-
-### Anvil
-
-```shell
-$ anvil
-```
-
-### Deploy
-
-```shell
-$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
-```
-
-### Cast
-
-```shell
-$ cast <subcommand>
-```
-
-### Help
-
-```shell
-$ forge --help
-$ anvil --help
-$ cast --help
-```