Merge pull request #37 from IntersectMBO/feat/add-architecture-diagram

Feat/add architecture diagram
IntersectMBO · Jan 29, 2025 · e2e437f · e2e437f
2 parents be23462 + 32a3d82
commit e2e437f
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,20 @@
 # Intersect Council Toolkit App
 
-Welcome to the Intersect Council Toolkit App repository.
+This App will allow Intersect council to be able to vote on governance actions, by connecting their wallet to this app.
 
-## Introduction
+## Table of Contents
 
-This application is intended to be used by Intersect's Constitutional Council to sign votes.
+1. [Usage](#usage)
+2. [Architecture](#architecture)
+3. [License](#license)
+
+## Usage
+
+1. Connect your wallet to the app.
+2. Make sure you are on the mainnet or pre-prod for testing.
+3. Paste your unsigned transaction on the input box, then click check transaction.
+4. If the unsigned transaction passes all validity checks you will be able to pass the transaction to your wallet for signing, producing a signature.
+
+## Architecture
+
+![Architecture](./docs/images/v1-architecture.PNG)
diff --git a/docs/images/v1-architecture.PNG b/docs/images/v1-architecture.PNG
diff --git a/src/README.md b/src/README.md