Skip to content

Commit 4a8c194

Browse files
committed
Update README.md
1 parent 520236b commit 4a8c194

File tree

2 files changed

+451
-6
lines changed

2 files changed

+451
-6
lines changed

Diff for: README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,14 @@
1414
OpenReader WebUI is a document reader with Text-to-Speech capabilities, offering a TTS read along experience with narration for both PDF and EPUB documents. It can use any OpenAI compatible TTS endpoint, including [Kokoro-FastAPI](https://github.com/remsky/Kokoro-FastAPI).
1515

1616
- 🎯 **TTS API Integration**: Compatible with OpenAI text to speech API, Kokoro FastAPI TTS, or any other compatible service; enabling high-quality voice narration
17-
- 💾 **Local-First Architecture**: Uses IndexedDB browser storage - no server uploads required
17+
- 💾 **Local-First Architecture**: Uses IndexedDB browser storage for documents
1818
- 🛜 **Optional Server-side documents**: Manually upload documents to the next backend for all users to download
1919
- 📖 **Read Along Experience**: Follow along with highlighted text as the TTS narrates
20-
- 📚 **EPUB Support**: Read EPUB files with table of contents
21-
- 📄 **PDF Support**: Read PDF files with clean text extraction
20+
- 📄 **Document formats**: EPUB, PDF, DOCX
2221
- 🎧 **Audiobook Creation**: Create and export audiobooks from PDF and ePub files with m4b format
2322
- 📲 **Mobile Support**: Works on mobile devices, and can be added as a PWA web app
2423
- 🎨 **Customizable Experience**:
25-
- 🔑 Set TTS API base URL (with optional API key)
24+
- 🔑 Set TTS API base URL (and optional API key)
2625
- 🏎️ Adjustable playback speed
2726
- 📐 Customize PDF text extraction margins
2827
- 🗣️ Multiple voice options (checks `/v1/audio/voices` endpoint)
@@ -31,9 +30,10 @@ OpenReader WebUI is a document reader with Text-to-Speech capabilities, offering
3130

3231
### 🛠️ Work in progress
3332
- [x] **Audiobook creation and download** (m4b format)
34-
- [x] **Get PDFs on iOS working**
33+
- [x] **Get PDFs on iOS 17 and below working 🤞**
3534
- [ ] **End-to-end Testing**: More playwright tests (in progress)
36-
- [ ] **More document formats**: .txt, .docx, .md, etc.
35+
- [ ] **More document formats**: .txt, .md
36+
- [ ] **Support more TTS APIs**: ElevenLabs, Ollama, etc.
3737
- [ ] **Accessibility Improvements**
3838

3939
## 🐳 Docker Quick Start

0 commit comments

Comments
 (0)