Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/add architecture diagram #37

Merged
merged 3 commits into from
Jan 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Binary file added docs/images/v1-architecture.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 0 additions & 20 deletions src/README.md

This file was deleted.