Merge pull request #5 from flare-research/update-readme

feat: make the readme based on structure

Author: magurh

README.md

@@ -19,7 +19,7 @@ Flare AI SDK for Consensus Learning.
 - **Modular & Configurable**
   Easily customize models, conversation prompts, and aggregation parameters through a simple JSON configuration.
 
-## 📌 Prerequisites
+## 🎯 Getting Started
 
 Before getting started, ensure you have:
 
@@ -28,7 +28,7 @@ Before getting started, ensure you have:
 - [Docker](https://www.docker.com/)
 - An [OpenRouter API Key](https://openrouter.ai/settings/keys).
 
-## ⚙️ Environment Setup
+### Environment Setup
 
 ### Step 1: Install Dependencies
 
@@ -49,7 +49,7 @@ uv run python -m tests.credits
 uv run python -m tests.models
 ```
 
-## 🚀 Running Consensus Learning
+### Running Consensus Learning
 
 Configure your consensus learning instance in `src/input.json`, including:
 
@@ -71,7 +71,7 @@ Once configured, start the process with:
 uv run start-consensus
 ```
 
-## 🔧 Testing Endpoints
+### Testing Endpoints
 
 For granular testing, use the following endpoints:
 
@@ -89,6 +89,33 @@ For granular testing, use the following endpoints:
 
   _Tip:_ In interactive mode, type `exit` to quit.
 
+## 📁 Repo Structure
+
+```
+src/flare_ai_consensus/
+├── attestation/           # TEE attestation implementation
+│   ├── __init__.py
+│   ├── simulated_token.txt
+│   ├── vtpm_attestation.py
+│   └── vtpm_validation.py
+├── consensus/             # Core consensus learning
+│   ├── __init__.py
+│   ├── aggregator.py      # Response aggregation
+│   └── consensus.py       # Main CL implementation
+├── router/               # API routing and model access
+│   ├── __init__.py
+│   ├── base_router.py     # Base routing interface
+│   └── openrouter.py      # OpenRouter implementation
+├── utils/                # Utility functions
+│   ├── __init__.py
+│   ├── file_utils.py      # File operations
+│   └── parser_utils.py    # Input parsing
+├── __init__.py
+├── input.json            # Configuration file
+├── main.py               # Application entry
+└── settings.py           # Environment settings
+```
+
 ## 🚀 Deploy on TEE
 
 Deploy on a [Confidential Space](https://cloud.google.com/confidential-computing/confidential-space/docs/confidential-space-overview) using AMD SEV.
@@ -196,7 +223,7 @@ If you encounter issues, follow these steps:
 3. **Check Firewall Settings:**  
    Confirm that your instance is publicly accessible on port `80`.
 
-## 🔜 Next Steps & Future Directions
+## 💡 Next Steps
 
 - **Security & TEE Integration:**
   - Ensure execution within a Trusted Execution Environment (TEE) to maintain confidentiality and integrity.