Update README.md badges

This commit is contained in:
Richard Roberson 2025-02-26 06:26:41 -07:00
parent 991304d134
commit a937e0ee07
2 changed files with 7 additions and 7 deletions

View file

@ -5,8 +5,8 @@
[![GitHub Last Commit](https://img.shields.io/github/last-commit/richardr1126/OpenReader-WebUI)](../../commits)
[![GitHub Release](https://img.shields.io/github/v/release/richardr1126/OpenReader-WebUI)](../../releases)
[![Container Image Size](https://img.shields.io/badge/dynamic/json?color=blue&label=image%20size&query=size&url=https://api.github.com/repos/richardr1126/OpenReader-WebUI/packages/container/openreader-webui/versions)](https://github.com/richardr1126/OpenReader-WebUI/pkgs/container/openreader-webui)
[![Container Version](https://img.shields.io/github/v/release/richardr1126/OpenReader-WebUI?label=container)](https://github.com/richardr1126/OpenReader-WebUI/pkgs/container/openreader-webui)
[![Discussions](https://img.shields.io/badge/Discussions-Ask%20a%20Question-blue)](../../discussions)
[![Bluesky](https://img.shields.io/badge/Bluesky-Chat%20with%20me-blue)](https://bsky.app/profile/richardr.dev)
# OpenReader WebUI 📄🔊
@ -41,7 +41,7 @@ https://github.com/user-attachments/assets/262b9a01-c608-4fee-893c-9461dd48c99b
docker run --name openreader-webui \
-p 3003:3003 \
-v openreader_docstore:/app/docstore \
ghcr.io/openreader-webui:latest
ghcr.io/richardr1126/openreader-webui:latest
```
(Optionally): Set the TTS `API_BASE` URL and/or `API_KEY` to be default for all devices
@ -50,7 +50,7 @@ docker run --name openreader-webui \
-e API_BASE=http://host.docker.internal:8880/v1 \
-p 3003:3003 \
-v openreader_docstore:/app/docstore \
ghcr.io/openreader-webui:latest
ghcr.io/richardr1126/openreader-webui:latest
```
> 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. If it is in a Docker you may need to use `host.docker.internal` to access the host machine, instead of `localhost`.
@ -62,7 +62,7 @@ Visit [http://localhost:3003](http://localhost:3003) to run the app and set your
### ⬆️ Update Docker Image
```bash
docker stop openreader-webui && docker rm openreader-webui
docker pull ghcr.io/openreader-webui:latest
docker pull ghcr.io/richardr1126/openreader-webui:latest
```
### Adding to a Docker Compose (i.e. with open-webui or Kokoro-FastAPI)
@ -74,7 +74,7 @@ volumes:
services:
openreader-webui:
container_name: openreader-webui
image: ghcr.io/openreader-webui:latest
image: ghcr.io/richardr1126/openreader-webui:latest
environment:
- API_BASE=http://host.docker.internal:8880/v1
ports:

View file

@ -1,6 +1,6 @@
{
"name": "openreader-webui",
"version": "0.2.2-patch.2",
"version": "0.2.2-patch.3",
"private": true,
"scripts": {
"dev": "next dev --turbopack",