Skip to content

Commit 340d289

Browse files
committed
Update README.md
1 parent 707dd92 commit 340d289

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33

44
# OpenReader WebUI
55

6-
OpenReader WebUI is a sleek, web-based PDF reader with built-in Text-to-Speech capabilities, offering a seamless reading experience with synchronized audio narration.
6+
OpenReader WebUI is a sleek, web-based reader with built-in Text-to-Speech capabilities, offering a seamless reading experience with synchronized audio narration for both PDF and EPUB documents. Read books with ease, listen to articles on the go, or study like you have your own lecturer, all in one place.
77

88
- 🎯 **TTS API Integration**: Compatible with OpenAI API TTS and Kokoro FastAPI TTS, enabling high-quality voice narration
99
- 💾 **Local-First Architecture**: Secure document handling with IndexedDB browser storage - no server uploads required
1010
- 🔍 **Smart Text Processing**: Real-time sentence detection and synchronized text highlighting during playback
11+
- 📚 **EPUB Support**: Read EPUB files with table of contents and synchronized text
12+
- 📄 **PDF Support**: Read PDF files with text extraction and page navigation
1113
-**Modern Tech Stack**: Built with Next.js, React, and Tailwind CSS
1214
- 🎨 **Customizable Experience**:
1315
- Adjustable playback speed
@@ -95,11 +97,14 @@ services:
9597
## Stack
9698

9799
- **Framework:** Next.js (React)
98-
- **Storage:** IndexedDB (in broswer db store)
100+
- **Storage:** IndexedDB (in browser db store)
99101
- **PDF Processing:**
100102
- [react-pdf](https://github.com/wojtekmaj/react-pdf)
101103
- [pdf.js](https://mozilla.github.io/pdf.js/)
102104
- Compromise for text analysis
105+
- **EPUB Processing:**
106+
- [react-reader](https://github.com/happyr/react-reader)
107+
- [epubjs](https://github.com/futurepress/epub.js/)
103108
- **UI Components:**
104109
- Headless UI
105110
- Tailwind CSS
@@ -126,11 +131,10 @@ This project is licensed under the MIT License.
126131
## Acknowledgements
127132

128133
- [react-pdf](https://github.com/wojtekmaj/react-pdf)
134+
- [react-reader](https://github.com/happyr/react-reader)
129135
- [Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M) for text-to-speech
130136
- [Kokoro-FastAPI](https://github.com/remsky/Kokoro-FastAPI) for the API wrapper
131137

132138
## Support
133139

134140
If you encounter issues or have suggestions, please open an issue on GitHub.
135-
136-
<!-- ...existing sections for further documentation or credits if needed... -->

0 commit comments

Comments
 (0)