readme tweaks

This commit is contained in:
ponzischeme89
2026-01-17 23:05:02 +13:00
parent 0241d1acd4
commit fa8f6af721
+45 -7
View File
@@ -1,13 +1,10 @@
# Sublogue
Sublogue is a small, fast tool for adding plot summaries and metadata to subtitle files.
Built in New Zealand for people who like tidy media libraries and clean viewing experiences.
Sublogue is a lightweight tool for adding plot summaries and metadata to subtitle files.
It takes an existing `.srt` file, fetches metadata from OMDb/TMDb and TVMaze, and inserts a short plot block at the start of the file — without touching any existing timings or shifting dialogue.
It takes an existing .srt, pulls data from OMDb, TMDb, and TVMaze, and inserts a short plot block at the start of the file — without altering any existing timings or dialogue.
If youve ever opened a movie and forgotten what its about, this fixes that.
---
If youve ever opened a movie or episode and thought “wait… what was this again?”, Sublogue quietly solves that.
## Features
@@ -19,4 +16,45 @@ If youve ever opened a movie and forgotten what its about, this fixes that
- Fast Python backend (Flask + aiohttp)
- Docker image available through GHCR
---
## Docker Compose
Create `data/` and `media/` folders next to the compose file, then run:
```yaml
version: "3.9"
services:
sublogue:
image: ponzischeme89/sublogue:latest
container_name: sublogue
restart: unless-stopped
environment:
- TZ=Etc/UTC
- PUID=1000
- PGID=1000
volumes:
- ./data:/config
- ./media:/media
ports:
- "5000:5000"
```
Then start it with:
```bash
docker compose up -d
```
## Unraid
Sublogue includes an Unraid template at `unraid-sublogue.xml`. Import it in Unraid's Docker UI, then map:
- `/mnt/user/appdata/sublogue` -> `/config`
- `/mnt/user/appdata/sublogue/media` -> `/media`
Start the container and open `http://<UNRAID-IP>:5000`.
## Acknowledgements
- Svelte for the frontend UI.
- Flask for the backend API.
- asyncio for async metadata fetching.