Commit 35c6ca9
Comprehensive README overhaul: features, better docs, removed icecast
Major improvements to documentation:
**Features Section (NEW):**
- Comprehensive features list at the top of README
- Organized into: Core Streaming, AI Features, Data & Analytics, Developer Experience
- Clear descriptions of all capabilities (transcription, summarization, weekly summaries, smart suggestions, etc.)
**Quick Start (IMPROVED):**
- Step-by-step guide for developers (7 clear steps)
- Minimum vs full configuration examples
- Detailed explanation of important settings
- Better organized with Prerequisites section
**Getting API Keys (IMPROVED):**
- Step-by-step instructions for OpenAI, Gemini, Trilium, ElevenLabs
- Cost information included with each provider
- Free tier details for Gemini
**Configuration Reference (NEW):**
- Comprehensive tables of all environment variables
- Organized by category (Core, Audio, Transcription, Trilium, etc.)
- Clear defaults and descriptions
**API Endpoints (IMPROVED):**
- Better organized by category
- More examples with curl commands
- Response format examples
**Cost Estimates (IMPROVED):**
- Added Light/Moderate/Heavy usage examples
- Clearer monthly cost breakdowns
- Better explanation of Gemini free tier
**Running as a Service (IMPROVED):**
- Better step-by-step systemd setup
- Updating section with ./update.sh details
**Development (IMPROVED):**
- Setting up dev environment
- Running tests with examples
- Code quality tools
- Project structure diagram
- Database migrations
- CI/CD overview
**Architecture (NEW):**
- Streaming pipeline explanation
- Multi-client streaming details
- Transcription pipeline flow
- Background processing model
**Troubleshooting (NEW):**
- Common issues with solutions
- Port conflicts, missing dependencies, database locks, Trilium connection
**Removed icecast:**
- Removed all references to icecast2 from README, CLAUDE.md, and setup.sh
- Application doesn't use icecast, only ffmpeg for streaming
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>1 parent 7fdf803 commit 35c6ca9
3 files changed
+710
-248
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
205 | 205 | | |
206 | 206 | | |
207 | 207 | | |
208 | | - | |
209 | 208 | | |
210 | 209 | | |
211 | 210 | | |
212 | 211 | | |
213 | | - | |
| 212 | + | |
214 | 213 | | |
215 | 214 | | |
216 | 215 | | |
| |||
611 | 610 | | |
612 | 611 | | |
613 | 612 | | |
614 | | - | |
| 613 | + | |
615 | 614 | | |
616 | 615 | | |
617 | 616 | | |
| |||
0 commit comments