Skip to content

Commit 8d42e69

Browse files
Added a warning about the state of the project
Overall we want to communicate that this is a PoC and avoid to overpromise for now
1 parent 60153c9 commit 8d42e69

1 file changed

Lines changed: 11 additions & 16 deletions

File tree

README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
11
# Readium Speech Server
22

3-
A remote text-to-speech HTTP service for the [Readium](https://readium.org) ecosystem. Exposes a uniform API for listing voices and synthesizing speech, backed by open neural TTS models running on CPU — no GPU required.
3+
> [!IMPORTANT]
4+
> Readium Speech Server is a proof of concept exploring how TTTS (Text to Speech) models can be either hosted or proxied through a single Web service.
5+
>
6+
> This project is not currently production-ready and it's missing key features such as caching or long term storage options.
47
5-
Designed to pair with [Readium Speech](https://github.com/readium/speech) and any Readium-compatible reading application.
8+
A remote text-to-speech HTTP service for the [Readium](https://readium.org) ecosystem. Exposes a uniform API for listing voices and synthesizing speech, backed by open-source models and proxied commercial models.
9+
10+
Designed to pair with [Readium Speech](https://github.com/readium/speech), Readium toolkits or any other application.
611

712
---
813

914
## Overview
1015

1116
| | |
1217
|---|---|
13-
| **API** | `GET /v1/voices` · `POST /v1/synthesize` |
14-
| **Providers** | PocketTTS (v1) · Kokoro, ElevenLabs, Azure (planned) |
18+
| **API** | `GET /voices` · `POST /synthesize` |
19+
| **Providers** | PocketTTS · ElevenLabs (planned) |
1520
| **Languages** | English · French · Italian · German · Spanish · Portuguese |
1621
| **Formats** | MP3 · WAV · Opus |
17-
| **Word boundaries** | Schema ready, not yet populated by any provider |
18-
| **Deployment** | Docker · CPU-only · single named volume for model weights |
22+
| **Word boundaries** | Planned (ElevenLabs) |
23+
| **Deployment** | Docker · CPU-only · Single named volume for model weights |
1924

2025
---
2126

@@ -333,16 +338,6 @@ Client
333338

334339
---
335340

336-
## Provider roadmap
337-
338-
| Provider | Status | Notes |
339-
|---|---|---|
340-
| PocketTTS | Current| CPU · 6 languages · 156 voices (26 identities × 6 languages) |
341-
| Kokoro | Planned | Referenced, not vendored (IP cleanliness) |
342-
| ElevenLabs | Planned | Proxied · word boundaries supported |
343-
| Azure Speech | Planned | Proxied · word boundaries supported |
344-
345-
---
346341

347342
## Related projects
348343

0 commit comments

Comments
 (0)