Skip to content

Commit 9ae7c39

Browse files
committed
Update README.md
1 parent 43b54ba commit 9ae7c39

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,16 @@ OpenReader WebUI is a document reader with Text-to-Speech capabilities, offering
1717
- 🎯 **TTS API Integration**: Compatible with OpenAI text to speech API, Kokoro FastAPI TTS, or any other compatible service; enabling high-quality voice narration
1818
- 💾 **Local-First Architecture**: Uses IndexedDB browser storage - no server uploads required
1919
- 🛜 **Optional Server-side documents**: Manually upload documents to the next backend for all users to download
20-
- 🔍 **Smart Text Processing**: Splits content into sentence blocks (ePub tries to split at paragraphs)
21-
- 📚 **EPUB Support**: Read EPUB files with table of contents and synchronized text
22-
- 📄 **PDF Support**: Read PDF files with text extraction and page navigation
20+
- 📖 **Read Along Experience**: Follow along with highlighted text as the TTS narrates
21+
- 🎧 **Audiobook Creation**: Create and export audiobooks from PDF and ePub files with m4b format
22+
- 📚 **EPUB Support**: Read EPUB files with table of contents
23+
- 📄 **PDF Support**: Read PDF files with clean text extraction
2324
- 💬 Follow along with highlighted text as the TTS narrates
2425
- 📲 **Mobile Support**: Works on mobile devices, and can be added as a PWA web app
2526
- 🎨 **Customizable Experience**:
2627
- 🔑 Set TTS API base URL (with optional API key)
2728
- 🏎️ Adjustable playback speed
29+
- 📐 Customize PDF text extraction margins
2830
- 🗣️ Multiple voice options (checks `/v1/audio/voices` endpoint)
2931
- 🎨 Multiple app theme options
3032

@@ -87,6 +89,7 @@ services:
8789
8890
### Prerequisites
8991
- Node.js & npm (recommended: use [nvm](https://github.com/nvm-sh/nvm))
92+
- [FFmpeg](https://ffmpeg.org) (required for audiobook m4b creation only)
9093
9194
### Steps
9295

0 commit comments

Comments
 (0)