Skip to content

Commit 35c6ca9

Browse files
MrDesjardinsclaude
andcommitted
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

File tree

3 files changed

+710
-248
lines changed

3 files changed

+710
-248
lines changed

CLAUDE.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -205,12 +205,11 @@ FASTAPI_HOST=10.0.0.181 FASTAPI_API_PORT=8000 uv run main.py
205205
Required system packages:
206206
- `yt-dlp` - YouTube audio extraction
207207
- `ffmpeg` - Audio conversion and streaming
208-
- `icecast2` - Optional for streaming infrastructure
209208

210209
Install with:
211210
```sh
212211
sudo apt update
213-
sudo apt install -y yt-dlp ffmpeg icecast2
212+
sudo apt install -y yt-dlp ffmpeg
214213
```
215214

216215
Note: The application expects `yt-dlp` to be at `/usr/local/bin/yt-dlp` (see main.py:30).
@@ -611,7 +610,7 @@ Run the setup script to install dependencies and initialize the database:
611610
```
612611

613612
This script will:
614-
1. Install system dependencies (yt-dlp, ffmpeg, icecast2)
613+
1. Install system dependencies (yt-dlp, ffmpeg)
615614
2. Install uv (Python package manager) if not present
616615
3. Install Python dependencies via `uv sync`
617616
4. Initialize the SQLite database with proper schema

0 commit comments

Comments
 (0)