From f8cb35efbf2d6a04d302503f198b904f0ceb9400 Mon Sep 17 00:00:00 2001
From: RohitAudit <737rohit.a@gmail.com>
Date: Sun, 7 Jan 2024 22:31:01 +0530
Subject: [PATCH] added README

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/README.md b/README.md
index f09d863..a06e05b 100644
--- a/README.md
+++ b/README.md
@@ -17,3 +17,37 @@ onboarding any rollup. Rollup has 3 choices as of now for bridge design:
 - **[Withdrawal](contracts/Withdrawal.sol)**: This is contract that is created for rollups when they
 register with Nexus Network. This contract receives rewards that are earned by validators created through
 their bridge contract.
+
+### Testing and Deploying
+Testing:
+- For testing the contracts one would need to enable forking in hardhat config
+```
+    networks: {
+      hardhat: {
+        forking: {
+          enabled: true,
+          url: process.env.GOERLI_URL || "",
+        },
+      }
+    }
+```
+- You can run the following command to run the unit test cases
+```
+npm run test:all
+```
+
+Deploying:
+- Local network
+```
+npm run deploy:local
+```
+- Goerli network
+```
+npm run deploy:goerli
+```
+- For verifying the contracts:
+```
+npm run verify:goerli
+```
+
+All the contracts address after deployment are stored in **output_network.json**
\ No newline at end of file