Skip to content

update readme #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
minhsaco99 merged 1 commit into from
Jan 22, 2026
Merged

update readme #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,17 @@ It abstracts away the complexities of model management, threading, and resource
| **🛡️ Production Ready** | Includes health checks, readiness probes, OpenTelemetry-ready metrics hooks, and graceful shutdown. |
| **🐳 Docker Friendly** | Ready for containerization with environment-variable overrides for flexible deployments. |

### 🤔 Why VoiceCore?

| Feature | Why It Matters |
| ------- | -------------- |
| **Pluggable Engines** | Swap Whisper for Google/Azure/custom engines without changing application code |
| **Word-Level Timestamps** | Essential for subtitles, karaoke apps, audio-text alignment |
| **Built-in Performance Metrics** | RTF, latency, time-to-first-token included in every response |
| **Triple Streaming Modes** | Batch, SSE, and WebSocket - pick the right mode for your use case |
| **YAML Configuration** | Switch models, devices (CPU/GPU), or compute types without code changes |
| **Self-Hosted** | Full data privacy, no API costs, works offline |

---

## 🏗️ Architecture
Expand Down