Update README quick-start and adjust tests

Add a Quick Start docker-compose snippet and simplify the Manual Setup instruction in README; also replace three screenshot assets. Update multiple audiobook component tests to match recent UI changes: adjust expected button/notification text (e.g. 'Sign in to Request', 'Request created!'), change selectors for close/interactive controls, add PreferencesContext mock, reflect processing overlay and pending/denied status behavior, and update skeleton loader count (8 -> 10). These edits keep tests aligned with the current UI and improve getting-started docs.
This commit is contained in:
kikootwo
2026-02-05 12:22:26 -05:00
parent 93d33464bf
commit 2c9097f6b0
7 changed files with 49 additions and 25 deletions
+17 -5
View File
@@ -50,6 +50,22 @@ User friendly audible-backed searches, multi-file chapter merging, e-book sideca
**Prerequisites:** Docker, Plex or Audiobookshelf, qBittorrent or SABnzbd, Prowlarr
### Quick Start
```bash
# Download docker-compose.yml
curl -fsSL https://raw.githubusercontent.com/kikootwo/readmeabook/main/docker-compose.yml -o docker-compose.yml
# Start the container
docker compose up -d
```
Open http://localhost:3030 and follow the setup wizard.
### Manual Setup
If you prefer to customize the compose file:
```yaml
services:
readmeabook:
@@ -71,11 +87,7 @@ services:
PUBLIC_URL: "https://audiobooks.example.com" # Required for OAuth
```
```bash
docker compose up -d
```
Open http://localhost:3030 and follow the setup wizard.
Then run `docker compose up -d` to start.
**Important:** Your download client (qBittorrent/SABnzbd) and RMAB must see files at the same path. See the [Volume Mapping Guide](documentation/deployment/volume-mapping.md) if downloads aren't being detected.