Update README.md

rawandahmad698 · web-flow · commit e2529f4002a4 · 2025-08-02T17:34:38.000+03:00
diff --git a/README.md b/README.md
@@ -1,38 +1,41 @@
-
 <img width="900" height="846" alt="github_export" src="https://github.com/user-attachments/assets/df798940-820c-46b6-b149-3a2771c7b5f3" />
 
+
 ## Screenshots
+<details>
+  <summary>View Screenshots</summary>
 
-### Recap Preview
-<img width="1139" height="565" alt="image" src="https://github.com/user-attachments/assets/65b41806-c86f-4c16-ab0f-4114da5dfd8c" />
+  ### Recap Preview
+  <img width="1139" height="565" alt="image" src="https://github.com/user-attachments/assets/65b41806-c86f-4c16-ab0f-4114da5dfd8c" />
 
-### Previous Recaps
-<img width="923" height="538" alt="image" src="https://github.com/user-attachments/assets/3b810b4f-a8b4-4755-bfd7-8ef1d3a3c953" />
+  ### Previous Recaps
+  <img width="923" height="538" alt="image" src="https://github.com/user-attachments/assets/3b810b4f-a8b4-4755-bfd7-8ef1d3a3c953" />
 
-### General Settings
-<img width="1038" height="524" alt="image" src="https://github.com/user-attachments/assets/5cfdf0d7-6c89-4f2e-9bae-8bfd6e14ca6d" />
+  ### General Settings
+  <img width="1038" height="524" alt="image" src="https://github.com/user-attachments/assets/5cfdf0d7-6c89-4f2e-9bae-8bfd6e14ca6d" />
 
-### Whisper Models Section
-<img width="1051" height="546" alt="image" src="https://github.com/user-attachments/assets/a3a3249b-b94d-492d-8009-3ad661cff45f" />
+  ### Whisper Models Section
+  <img width="1051" height="546" alt="image" src="https://github.com/user-attachments/assets/a3a3249b-b94d-492d-8009-3ad661cff45f" />
 
+</details>
 
 ## Why I Built This
 
-Ever been in a meeting where you wanted to focus on your work but still catch the important bits? That's exactly why I created Recap. 
+Ever been in a meeting where you wanted to focus on your work but still catch the important bits? That's exactly why I created Recap.
 
 I found myself constantly torn between paying attention to meetings and getting actual work done. Sometimes I'd miss crucial decisions while coding, or I'd lose my flow state trying to take notes. I needed something that could listen for me and give me the highlights afterward.
 
 But here's the thing - I didn't want my private conversations floating around on some company's servers. When you're discussing sensitive business matters, product roadmaps, or personal topics, that data should stay on YOUR machine. That's why Recap processes everything locally on your Mac using Apple's own technologies.
 
-Now, Recap is broken. But it is a project that I am always working on on my free time so it meets my needs. I hope it can help you too.
+Now, Recap is broken. But it is a project that I am always working on in my free time so it meets my needs. I hope it can help you too.
 
 ---
 
 > [!IMPORTANT]
-> Recap is not complete yet, it is broken, and not recommended for production usage. 
+> Recap is not complete yet, it is broken, and not recommended for production usage.
 
 > [!TIP]
-> Recap is in an incomplete state and I suggest that it is not used for production and daily usage, but help in shaping it is greatly appreciated. 
+> Recap is in an incomplete state and I suggest that it is not used for production and daily usage, but help in shaping it is greatly appreciated.
 
 # Recap
 
@@ -47,19 +50,19 @@ Built using native macOS technologies - no drivers or kernel extensions required
 
 **Core Audio**: Native Core Audio taps, AVAudioEngine, driver-free system audio capture  
 **ML**: WhisperKit (local transcription), Ollama/OpenRouter (summarization)  
-**Platform**: Swift + SwiftUI, Apple Silicon optimized, sandboxed execution 
+**Platform**: Swift + SwiftUI, Apple Silicon optimized, sandboxed execution
 
-### Roadmap: 
+### Roadmap:
 
 Working on the following features now:
 - [ ] Meeting Detection (Teams, Zoom, Google etc)
 - [ ] Custom Prompt Via Settings
-- [ ] Background Audio Processing 
+- [ ] Background Audio Processing
 - [ ] Auto Recording Stop
 - [ ] Better Error Handling
 - [ ] 85% or more test coverage
 
-Right now, Recap is more of a POC of what I am trying to make. It records system audio (Core Audio Taps) + with an optional microphone recording (your audio) and feeds it to Whisper for transcription and then uses Ollama for summarizing. 
+Right now, Recap is more of a POC of what I am trying to make. It records system audio (Core Audio Taps) + with an optional microphone recording (your audio) and feeds it to Whisper for transcription and then uses Ollama for summarizing.
 
 **LLM Provider Options:**
 - **Ollama** (recommended): Complete privacy - everything stays on your device
@@ -71,16 +74,16 @@ Right now, Recap is more of a POC of what I am trying to make. It records system
 
 | Component | Minimum | Recommended |
 |-----------|---------|-------------|
-| **macOS** | 15.0 or later| 15.0 or later |
-| **Processor** | Apple M1 | Apple M2 Pro or newer |
+| **macOS** | 15.0 or later | 15.0 or later |
+| **Processor** | Apple M1  | Apple M2 Pro or newer |
 | **RAM** | 16 GB | 32 GB or more |
 | **Storage** | 10 GB free space | 50 GB free space |
 
 ### For OpenRouter (Cloud Processing)
 
 | Component | Minimum | Recommended |
 |-----------|---------|-------------|
-| **macOS** | 15.0 or later| 15.0 or later |
+| **macOS** | 15.0 or later | 15.0 or later |
 | **Processor** | Apple M1 | Apple M2 or newer |
 | **RAM** | 8 GB | 16 GB or more |
 | **Storage** | 2 GB free space | 5 GB free space |
@@ -89,14 +92,14 @@ Right now, Recap is more of a POC of what I am trying to make. It records system
 
 ## How It Works
 
-```
+```text
                                   DATA FLOW
                               ┌───────────────┐
                           ┌───┤ 1. App Start  │
                           │   └───────────────┘
                           ▼
                     ┌─────────────┐
-                    │2. App Select│
+                    │2. App Select │
                     └─────────────┘
                           │
                           ▼
@@ -126,7 +129,7 @@ Right now, Recap is more of a POC of what I am trying to make. It records system
                │   • Update DB Record   │
                │   • Show Results       │
                └────────────────────────┘
-```
+````
 
 ## Installation
 
@@ -135,19 +138,22 @@ Currently, Recap is only available through compilation from source. Pre-built re
 ### Compile from Source
 
 1. **Prerequisites:**
-   - Ensure your system meets the [requirements](#system-requirements) above
-   - Install Xcode 15.0 or later from the Mac App Store
+
+   * Ensure your system meets the [requirements](#system-requirements) above
+   * Install Xcode 15.0 or later from the Mac App Store
 
 2. **Clone and Build:**
+
    ```bash
    git clone https://github.com/your-username/recap.git
    cd recap
    open Recap.xcodeproj
    ```
 
 3. **Build in Xcode:**
-   - Select your development team in project settings
-   - Build and run (⌘+R)
+
+   * Select your development team in project settings
+   * Build and run (⌘+R)
 
 > **Note**: Distribution via Mac App Store and direct download will be available in future releases once the app reaches production readiness.
 
@@ -157,65 +163,75 @@ Currently, Recap is only available through compilation from source. Pre-built re
 
 Before using Recap, you need to set up the following environment variables:
 
-- **`HF_TOKEN`** (Required): Hugging Face token for downloading Whisper models
+* **`HF_TOKEN`** (Required): Hugging Face token for downloading Whisper models
+
   ```bash
   export HF_TOKEN="your_huggingface_token_here"
   ```
-  
-- **`OPENROUTER_API_KEY`** (Optional): Only required if using OpenRouter for summarization
+
+* **`OPENROUTER_API_KEY`** (Optional): Only required if using OpenRouter for summarization
+
   ```bash
   export OPENROUTER_API_KEY="your_openrouter_api_key_here"
   ```
 
 ### First-Time Setup
 
 1. **Download Whisper Model:**
-   - Open Recap and go to **Settings → Whisper Models**
-   - Download a Whisper model (recommended: **Large v3** for best accuracy)
-   - Wait for the download to complete before proceeding
+
+   * Open Recap and go to **Settings → Whisper Models**
+   * Download a Whisper model (recommended: **Large v3** for best accuracy)
+   * Wait for the download to complete before proceeding
 
 2. **Configure LLM Provider:**
-   - Go to **Settings → LLM Models**
-   - Choose your preferred provider (Ollama or OpenRouter)
-   - If using Ollama, ensure it's installed and running locally
+
+   * Go to **Settings → LLM Models**
+   * Choose your preferred provider (Ollama or OpenRouter)
+   * If using Ollama, ensure it's installed and running locally
 
 3. **Start Recording:**
-   - Select an audio application from the dropdown
-   - Click the record button to start capturing
-   - Optionally enable microphone for dual-audio recording
-   - Click stop when finished - processing will begin automatically
+
+   * Select an audio application from the dropdown
+   * Click the record button to start capturing
+   * Optionally enable microphone for dual-audio recording
+   * Click stop when finished - processing will begin automatically
 
 ## Tech Stack
 
 Recap is built using native macOS technologies, avoiding third-party drivers and kernel extensions for maximum system stability and security.
 
 ### Core Audio Implementation
-- **Native Core Audio**: Direct integration with macOS audio subsystem
-- **Audio Unit Taps**: System-level audio interception without drivers
-- **AVAudioEngine**: Modern Swift audio processing pipeline
-- **No Kernel Extensions**: Driver-free audio capture using Apple's official APIs
-- **Process-Specific Capture**: Target individual applications without affecting system audio
+
+* **Native Core Audio**: Direct integration with macOS audio subsystem
+* **Audio Unit Taps**: System-level audio interception without drivers
+* **AVAudioEngine**: Modern Swift audio processing pipeline
+* **No Kernel Extensions**: Driver-free audio capture using Apple's official APIs
+* **Process-Specific Capture**: Target individual applications without affecting system audio
 
 ### Technologies Used
-- **Language**: Swift 5.9+
-- **UI Framework**: SwiftUI + AppKit (menu bar integration)
-- **Audio Processing**: Core Audio, AVAudioEngine, Audio Toolbox
-- **Machine Learning**: 
-  - WhisperKit (local speech-to-text)
-  - MLX/CoreML optimization for Apple Silicon
-- **LLM Integration**: 
-  - Ollama (local inference)
-  - OpenRouter (cloud API)
-- **Data Storage**: Core Data + local file system
-- **Concurrency**: Swift async/await, structured concurrency
-- **Architecture**: MVVM, Coordinator pattern, Dependency injection
+
+* **Language**: Swift 5.9+
+* **UI Framework**: SwiftUI + AppKit (menu bar integration)
+* **Audio Processing**: Core Audio, AVAudioEngine, Audio Toolbox
+* **Machine Learning**:
+
+  * WhisperKit (local speech-to-text)
+  * MLX/CoreML optimization for Apple Silicon
+* **LLM Integration**:
+
+  * Ollama (local inference)
+  * OpenRouter (cloud API)
+* **Data Storage**: Core Data + local file system
+* **Concurrency**: Swift async/await, structured concurrency
+* **Architecture**: MVVM, Coordinator pattern, Dependency injection
 
 ### Security & Privacy Benefits
-- **Sandboxed Execution**: Runs within macOS security boundaries
-- **No System Modifications**: Zero kernel-level changes required
-- **Permission-Based**: Uses standard macOS audio permissions
-- **Local Processing**: WhisperKit keeps transcription on-device
-- **Secure Audio Taps**: Apple's blessed method for audio interception
+
+* **Sandboxed Execution**: Runs within macOS security boundaries
+* **No System Modifications**: Zero kernel-level changes required
+* **Permission-Based**: Uses standard macOS audio permissions
+* **Local Processing**: WhisperKit keeps transcription on-device
+* **Secure Audio Taps**: Apple's blessed method for audio interception
 
 ## Contributing
 
@@ -224,14 +240,16 @@ I really need help finishing Recap! Any contribution is greatly welcomed.
 ### Priority Areas
 
 **Critical needs:**
-- See Roadmap above for current focus areas
+
+* See Roadmap above for current focus areas
 
 **Also needed:**
-- Meeting app detection improvements
-- Custom prompt templates via settings
-- Performance optimizations
-- Documentation improvements
-- Bug fixes and stability improvements
+
+* Meeting app detection improvements
+* Custom prompt templates via settings
+* Performance optimizations
+* Documentation improvements
+* Bug fixes and stability improvements
 
 ### How to Contribute
 
@@ -241,20 +259,22 @@ I really need help finishing Recap! Any contribution is greatly welcomed.
 4. **Test your changes** thoroughly on Apple Silicon Macs
 5. **Submit a pull request** with clear description of changes
 
-All skill levels welcome - from fixing typos to architecting new features. Let's build something great together. I really mean it!
+All skill levels welcome - from fixing typos to architecting new features. I really mean it!
 
 ## License
 
-This project is licensed under the **Creative Commons Attribution-NonCommercial 4.0 International License**.
+Copyright © 2025 Rawand Ahmed Shaswar
 
-**What this means:**
-- ✅ **Free personal use** - Use, modify, and share for personal projects
-- ✅ **Open source contributions** - Fork, improve, and contribute back
-- ✅ **Educational use** - Perfect for learning and teaching
-- ❌ **Commercial redistribution** - Cannot resell or distribute commercially without permission
-- ❌ **App Store uploads** - Cannot publish to app stores for profit
+Permission is hereby granted to any person or entity to use, modify, and deploy
+this software for any purpose, commercial or otherwise, provided that this notice
+appears in all copies or substantial portions of the software.
 
-If you want to use Recap commercially or have questions about licensing, please reach out to discuss options.
+Redistribution of this software, in source or binary form, original or modified,
+is prohibited without express prior written consent from the copyright holder.
+
+**What this means:**
 
-See the [LICENSE](LICENSE) file for full details.
+* ✅ **Any kind of usage allowed** — personal, educational, or commercial use and modification is permitted.
+* ❌ **Redistribution prohibited** — you may not redistribute the original or modified project in any form.
 
+Please see the [LICENSE](LICENSE) file for full details.
