Enhance README with workflow, modes, controls, and performance details
Summary
This MR improves the project documentation by enhancing the README.md with detailed explanations of system workflow, recording modes, controls, and performance characteristics.
The update makes the README more clear, user-friendly, and production-ready, helping both developers and non-technical users understand how the application works.
Changes Made
Added Sections
-
How It Works
-
Step-by-step explanation of the full pipeline:
- Audio capture → VAD → API → model inference → UI update
-
-
Recording Modes
-
Detailed explanation of:
- Push-to-Talk mode
- Continuous mode (with silence detection)
-
-
Controls
-
Clear behavior of:
- Start Recording
- Stop Recording
- Reset/Clear
- Copy and Download
-
-
Performance
-
Added realistic timing details:
- Initial model loading time (~5–10s)
- Subsequent inference time (~1–2s)
- VAD silence delay (~2s)
-
-
Feature Details
-
Expanded explanations for key features:
- Voice Activity Detection (VAD)
- Auto-save (LocalStorage)
- Undo/Redo
- Timer
- Word/Character count
-
-
Stopping Behavior
- Clarifies what happens when recording is stopped
- Explains handling of in-progress audio
Improvements
-
Improves readability and structure of README
-
Bridges the gap between feature list and actual functionality
-
Makes the project easier to understand for new contributors
-
Enhances documentation quality for:
- GitHub showcase
- Academic/project evaluation
- Developer onboarding
Impact
- Documentation-only changes
- No impact on application functionality
- No breaking changes
Testing
- Verified Markdown formatting and structure
- Ensured consistency with implemented features
- Confirmed readability and logical flow
Notes
This MR focuses only on improving documentation and does not introduce any new features or modify existing code.
closes #19 (closed)