You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-9Lines changed: 7 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,16 +11,15 @@
11
11
12
12
# OpenReader WebUI 📄🔊
13
13
14
-
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/tree/v0.0.5post1-stable).
14
+
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).
15
15
16
16
- 🎯 **TTS API Integration**: Compatible with OpenAI text to speech API, Kokoro FastAPI TTS, or any other compatible service; enabling high-quality voice narration
17
17
- 💾 **Local-First Architecture**: Uses IndexedDB browser storage - no server uploads required
18
18
- 🛜 **Optional Server-side documents**: Manually upload documents to the next backend for all users to download
19
19
- 📖 **Read Along Experience**: Follow along with highlighted text as the TTS narrates
20
-
- 🎧 **Audiobook Creation**: Create and export audiobooks from PDF and ePub files with m4b format
21
20
- 📚 **EPUB Support**: Read EPUB files with table of contents
22
21
- 📄 **PDF Support**: Read PDF files with clean text extraction
23
-
- 💬 Follow along with highlighted text as the TTS narrates
22
+
- 🎧 **Audiobook Creation**: Create and export audiobooks from PDF and ePub files with m4b format
24
23
- 📲 **Mobile Support**: Works on mobile devices, and can be added as a PWA web app
25
24
- 🎨 **Customizable Experience**:
26
25
- 🔑 Set TTS API base URL (with optional API key)
@@ -31,11 +30,11 @@ OpenReader WebUI is a document reader with Text-to-Speech capabilities, offering
31
30
32
31
33
32
### 🛠️ Work in progress
34
-
☑**Audiobook creation and download** (m4b format) <br>
35
-
☑**Get PDFs on iOS working** <br>
36
-
☐**More documents formats**: .txt, .docx, .md, etc. <br>
37
-
☐**End-to-end Testing**: Playwright tests (in progress) <br>
38
-
☐**Accessibility Improvements**: Ongoing
33
+
-[x]**Audiobook creation and download** (m4b format)
34
+
-[x]**Get PDFs on iOS working**
35
+
-[ ]**End-to-end Testing**: More playwright tests (in progress)
36
+
-[ ]**More document formats**: .txt, .docx, .md, etc.
37
+
-[ ]**Accessibility Improvements**
39
38
40
39
## 🐳 Docker Quick Start
41
40
@@ -155,7 +154,6 @@ Contributions are welcome! Fork the repository and submit a pull request with yo
0 commit comments