From ae9cb8fa62325d4ca9fd44e96744c6cbc30769bf Mon Sep 17 00:00:00 2001
From: hemanthghs <ghshemanth@gmail.com>
Date: Thu, 22 Aug 2024 16:12:08 +0530
Subject: [PATCH] chore: update readme and add example env file

---
 README.md             | 6 +++++-
 frontend/.env.example | 4 ++++
 server/README.md      | 2 ++
 3 files changed, 11 insertions(+), 1 deletion(-)
 create mode 100644 frontend/.env.example

diff --git a/README.md b/README.md
index 3df018467..1c712bed5 100644
--- a/README.md
+++ b/README.md
@@ -45,9 +45,13 @@ $ yarn
 
 ## Environment variables
 
-Create .env file and set multisig backend URI `NEXT_PUBLIC_APP_API_URI`
+Rename `.env.example` to `.env` and set multisig backend URI `NEXT_PUBLIC_APP_API_URI`, 
 You can setup your own multisig server in [Set up multisig server](./MULTISIG_SERVER_README.md).
 
+Set Squid ID `NEXT_PUBLIC_SQUID_ID`, You can get Squid ID from here [Squid ID](https://squidrouter.typeform.com/integrator-id?typeform-source=docs.squidrouter.com)
+
+To use Cosmwasm contracts set `NEXT_PUBLIC_DUMMY_WALLET_MNEMONIC`.
+
 ## Start in DEV Mode
 Runs the app in the development mode.<br />
 Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
diff --git a/frontend/.env.example b/frontend/.env.example
new file mode 100644
index 000000000..7c3e963a9
--- /dev/null
+++ b/frontend/.env.example
@@ -0,0 +1,4 @@
+NEXT_PUBLIC_APP_API_URI=<Backend URI>
+NEXT_PUBLIC_SQUID_ID=<SQUID ID>
+# To use Cosmwasm contracts provide the dummy wallet mnemonic, create a dummy wallet and add mnemonic here, also have minimum tokens in this wallet.
+NEXT_PUBLIC_DUMMY_WALLET_MNEMONIC=<Dummy mnemonic for cosmwasm contract>
\ No newline at end of file
diff --git a/server/README.md b/server/README.md
index a1eb97ea5..d2d15880b 100644
--- a/server/README.md
+++ b/server/README.md
@@ -14,6 +14,8 @@ This module provides backend code for [Resolute](https://resolute.vitwit.com), a
 
 For configuration we use YAML file format. To configure `backend` and `database`, you need to add `config.yaml` file. Reference `example.yaml`. 
 
+To get the transactions history you need to add your chain details in `server/networks.json` file.
+
 ## Database setup
 
 This project uses Postgres database. Before starting the server make sure to initialize database tables. You can find schema [Here](https://github.com/vitwit/resolute/server/schema/schema.sql).