Update README.md
This commit is contained in:
parent
8dfecbab73
commit
3568f3c8f9
2 changed files with 15 additions and 6 deletions
2
.github/workflows/docker-publish.yml
vendored
2
.github/workflows/docker-publish.yml
vendored
|
|
@ -46,7 +46,7 @@ jobs:
|
||||||
uses: docker/build-push-action@v5
|
uses: docker/build-push-action@v5
|
||||||
with:
|
with:
|
||||||
context: .
|
context: .
|
||||||
platforms: linux/amd64,linux/arm64,linux/arm/v7
|
platforms: linux/amd64,linux/arm64
|
||||||
push: true
|
push: true
|
||||||
tags: ${{ steps.meta.outputs.tags }}
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
labels: ${{ steps.meta.outputs.labels }}
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
|
|
|
||||||
17
README.md
17
README.md
|
|
@ -29,11 +29,15 @@ OpenReader WebUI is a document reader with Text-to-Speech capabilities, offering
|
||||||
- 🗣️ Multiple voice options (checks `/v1/audio/voices` endpoint)
|
- 🗣️ Multiple voice options (checks `/v1/audio/voices` endpoint)
|
||||||
- 🎨 Multiple app theme options
|
- 🎨 Multiple app theme options
|
||||||
|
|
||||||
## [**Demo**](https://openreader.richardr.dev/)
|
|
||||||
|
|
||||||
|
|
||||||
https://github.com/user-attachments/assets/262b9a01-c608-4fee-893c-9461dd48c99b
|
|
||||||
|
|
||||||
|
### 🛠️ Work in progress
|
||||||
|
- ☑ **Audiobook creation and download**
|
||||||
|
- ☐ **More documents formats**:
|
||||||
|
- ☑ **.epub** files
|
||||||
|
- ☐ **.txt** files
|
||||||
|
- ☐ **.docx** files
|
||||||
|
- ☐ **.md** files
|
||||||
|
- ☐ **End-to-end Testing**: Cypress tests
|
||||||
|
|
||||||
## 🐳 Docker Quick Start
|
## 🐳 Docker Quick Start
|
||||||
|
|
||||||
|
|
@ -84,6 +88,11 @@ services:
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## [**Demo**](https://openreader.richardr.dev/)
|
||||||
|
|
||||||
|
|
||||||
|
https://github.com/user-attachments/assets/262b9a01-c608-4fee-893c-9461dd48c99b
|
||||||
|
|
||||||
## Dev Installation
|
## Dev Installation
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue