Skip to content

Commit 5649312

Browse files
committed
Update README.md
1 parent e7c40b6 commit 5649312

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ OpenReader WebUI is a document reader with Text-to-Speech capabilities, offering
2020
- 🔍 **Smart Text Processing**: Splits content into sentence blocks (ePub tries to split at paragraphs)
2121
- 📚 **EPUB Support**: Read EPUB files with table of contents and synchronized text
2222
- 📄 **PDF Support**: Read PDF files with text extraction and page navigation
23-
-**Modern Tech Stack**: Built with Next.js, React, Tailwind CSS, and some Headless UI React
23+
- 💬 Follow along with highlighted text as the TTS narrates
24+
- 📲 **Mobile Support**: Works on mobile devices, and can be added as a PWA web app
2425
- 🎨 **Customizable Experience**:
25-
- Set TTS API base URL (with optional API key)
26-
- Adjustable playback speed
27-
- Multiple voice options (checks `/v1/audio/voices` endpoint)
28-
- Multiple app layout theme options
29-
- Persistent settings
26+
- 🔑 Set TTS API base URL (with optional API key)
27+
- 🏎️ Adjustable playback speed
28+
- 🗣️ Multiple voice options (checks `/v1/audio/voices` endpoint)
29+
- 🎨 Multiple app theme options
3030

3131
## [**Demo**](https://openreader.richardr.dev/)
3232

@@ -42,19 +42,19 @@ docker run --name openreader-webui \
4242
-v openreader_docstore:/app/docstore \
4343
richardr1126/openreader-webui:latest
4444
```
45-
> Note: The `openreader_docstore` volume is used to store server-side documents. You can mount a local directory instead. Or remove it if you don't need server-side documents.
45+
> **Note:** The `openreader_docstore` volume is used to store server-side documents. You can mount a local directory instead. Or remove it if you don't need server-side documents.
4646
47-
> Note: Requesting audio from the TTS API happens on the client not the Next.js server. So the API base URL needs to be accessible on the device that you are loading/hydrating the website on, not the device running the localhost:3003 Next.js server.
47+
Visit [http://localhost:3003](http://localhost:3003) to run the app and set your settings.
4848

49-
Visit [http://localhost:3003](http://localhost:3003) to run the app.
49+
> Requesting audio from the TTS API happens on the Next.js server not the client. So the base URL for the TTS API should be accessible and relative to the Next.js server.
5050
5151
### ⬆️ Update Docker Image
5252
```bash
5353
docker stop openreader-webui && docker rm openreader-webui
5454
docker pull richardr1126/openreader-webui:latest
5555
```
5656

57-
### Using Docker Compose
57+
### Adding to a Docker Compose (i.e. with open-webui or Kokoro-FastAPI)
5858
Create or add to a `docker-compose.yml`:
5959
```yaml
6060
volumes:
@@ -94,7 +94,7 @@ services:
9494
cp .env.template .env
9595
# Edit .env with your configuration settings
9696
```
97-
> Note: Requesting audio from the TTS API happens on the client not the Next.js server. So the API base URL needs to be accessible on the device that you are loading/hydrating the website on, not the device running the localhost:3003 Next.js server.
97+
> Note: The base URL for the TTS API should be accessible and relative to the Next.js server
9898
9999
4. Start the development server:
100100
```bash
@@ -141,19 +141,19 @@ Contributions are welcome! Fork the repository and submit a pull request with yo
141141
- **Framework:** Next.js (React)
142142
- **Containerization:** Docker
143143
- **Storage:** IndexedDB (in browser db store)
144-
- **PDF Processing:**
144+
- **PDF:**
145145
- [react-pdf](https://github.com/wojtekmaj/react-pdf)
146146
- [pdf.js](https://mozilla.github.io/pdf.js/)
147-
- [compromise](https://github.com/spencermountain/compromise): NLP library for sentence splitting
148-
- **EPUB Processing:**
147+
- **EPUB:**
149148
- [react-reader](https://github.com/happyr/react-reader)
150149
- [epubjs](https://github.com/futurepress/epub.js/)
151-
- **UI Components:**
152-
- [Headless UI](https://headlessui.com)
150+
- **UI:**
153151
- [Tailwind CSS](https://tailwindcss.com)
154-
- **TTS Integration:** (tested on)
152+
- [Headless UI](https://headlessui.com)
153+
- **TTS:** (tested on)
155154
- [OpenAI API](https://platform.openai.com/docs/api-reference/text-to-speech)
156155
- [Kokoro FastAPI TTS](https://github.com/remsky/Kokoro-FastAPI/tree/v0.0.5post1-stable)
156+
- **NLP:** [compromise](https://github.com/spencermountain/compromise) NLP library for sentence splitting
157157

158158
## License
159159

0 commit comments

Comments
 (0)