Skip to content

Commit 6f948a5

Browse files
Update README.md
1 parent df38fbb commit 6f948a5

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,25 @@
2323

2424
</details>
2525

26-
## Why I Built This
26+
## Jump to:
27+
28+
- [Why Recap?](#why-recap)
29+
- [Features](#features)
30+
- [System Requirements](#system-requirements)
31+
- [How It Works](#how-it-works)
32+
- [Installation](#installation)
33+
- [Usage](#usage)
34+
- [Contributing](#contributing)
35+
36+
## Why Recap?
2737

2838
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.
2939

3040
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.
3141

3242
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.
3343

34-
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.
44+
Recap is broken in its current state, but since I use it daily myself, you can absolutely expect new features soon!
3545

3646
---
3747

@@ -42,13 +52,15 @@ Now, Recap is broken. But it is a project that I am always working on in my free
4252

4353
Recap is an open-source, privacy-focused, macOS-native project to help you summarize your meetings. You could summarize audio of any app, not just meetings.
4454

45-
## Stack
46-
47-
#### Linter
48-
Not using any linter right now, but I am planning to use SwiftLint/SwiftFormat in the future (PRs greatly welcomed).
55+
## Features
56+
- **Meeting Detection**: Automatically detects meetings in Microsoft Teams, Zoom, Google Meet, and more using macOS ScreenCaptureKit (Coming Soon!)
57+
- **Audio Recording**: Records system audio and optionally microphone input
58+
- **Local Processing**: Uses WhisperKit for transcription and Ollama/OpenRouter for summarization, all on your Mac
59+
- **Privacy First**: No data leaves your device unless you choose to share it
60+
- **Open Source**: Fully transparent codebase for community contributions
4961

50-
Built using native macOS technologies - no drivers or kernel extensions required.
5162

63+
#### Under the hood
5264
- Native Core Audio taps, AVAudioEngine, driver-free system audio capture
5365
- WhisperKit (MLX) (local transcription), Ollama/OpenRouter (summarization)
5466
- Swift + SwiftUI
@@ -232,6 +244,9 @@ I really need help finishing Recap! Any contribution is greatly welcomed.
232244

233245
All skill levels welcome - from fixing typos to architecting new features. I really mean it!
234246

247+
#### Linter
248+
Not using any linter right now, but I am planning to use SwiftLint/SwiftFormat in the future (PRs greatly welcomed).
249+
235250
## License
236251

237252
Copyright © 2025 Rawand Ahmed Shaswar

0 commit comments

Comments
 (0)