From 48b3a010fc14f94eae4b71c615eb9b8bc3a65871 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 11 Jan 2026 05:10:43 +0000 Subject: [PATCH] docs: update README with new features and improvements Added documentation for recent enhancements: New Features: - Smart Chapter Detection & Pagination - Automatic chapter detection from natural markers - Size-based splitting for large files (~50KB chunks) - Seamless TTS auto-advance through chapters - Chapter navigation controls - Enhanced Audiobook Export - Now supports HTML/text documents in addition to EPUB/PDF - Accessible via gear icon in document viewer - Improved TTS Performance & Compatibility - Aggressive preloading (5 sentences ahead) - 50-sentence LRU cache - Blob URL audio for Firefox compatibility - Seamless error recovery Stack Updates: - Added Howler.js for cross-browser audio playback - Added custom chapter detection utility - Documented Blob URL usage for audio --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 02dc60d..b1e4f21 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,19 @@ OpenReader WebUI is an open source text to speech document reader web app built - 📖 *(Updated)* **Read Along Experience** providing real-time text highlighting during playback (PDF/EPUB) - *(New)* **Word-by-word** highlighting uses word-by-word timestamps generated server-side with [*whisper.cpp*](https://github.com/ggml-org/whisper.cpp) (optional) - 🧠 *(New)* **Smart Sentence-Aware Narration** merges sentences across pages/chapters for smoother TTS +- 📚 *(New)* **Smart Chapter Detection & Pagination** automatically splits large text files into chapters + - Detects natural chapter markers (Chapter 1, Part I, Section 1, etc.) + - Size-based splitting for files without chapters (~50KB chunks) + - Seamless TTS auto-advance through chapters during playback + - Chapter navigation with Previous/Next controls - 🎧 *(New)* **Reliable Audiobook Export** in **m4b/mp3**, with resumable, chapter-based export and regeneration -- 🚀 *(New)* **Optimized Next.js TTS Proxy** with audio caching and optimized repeat playback + - Supports EPUB, PDF, and HTML/text documents + - Accessible via gear icon in document viewer +- 🚀 *(Updated)* **Optimized Next.js TTS Proxy** with enhanced audio caching and cross-browser compatibility + - Aggressive preloading (5 sentences ahead) for seamless playback + - 50-sentence LRU cache for efficient memory usage + - Blob URL audio for improved Firefox compatibility + - Seamless error recovery (skips problematic sentences automatically) - 💾 **Local-First Architecture** stores documents and more in-browser with Dexie.js - 🛜 **Optional Server-side documents** using backend `/docstore` for all users - 🎨 **Customizable Experience** @@ -249,7 +260,11 @@ This project would not be possible without standing on the shoulders of these gi - **Markdown/Text:** - [react-markdown](https://github.com/remarkjs/react-markdown) - [remark-gfm](https://github.com/remarkjs/remark-gfm) -- **UI:** + - Custom chapter detection for pagination and navigation +- **Audio:** + - [Howler.js](https://howlerjs.com) for cross-browser audio playback + - Blob URL audio for efficient memory usage and Firefox compatibility +- **UI:** - [Tailwind CSS](https://tailwindcss.com) - [Headless UI](https://headlessui.com) - [@tailwindcss/typography](https://tailwindcss.com/docs/typography-plugin)