Commit 9a77293
authored
docs(readme): revamp with VHS demos, OpenClaw section, and logo grid (#203)
* feat(cli): polish doctor table output
Add ✓/✗/○ glyphs to the status column and drop the redundant
`configured` and noisy `baseUrl` columns from table mode (still
present in --json output). Makes `tsarr doctor` punchier in the
terminal and presentation-ready for README demos.
* docs(readme): revamp with VHS demos, OpenClaw section, and logo grid
Full README rewrite — drops bloat (Features bullets, Why bullets, Use
Cases, Development, Alternatives table, SEO sub-footer) and shifts to
a CLI-first hero with strong SDK supporting section. Adds two VHS
tape sources for hero and workflow demos, a dedicated OpenClaw section
showing chat-driven usage, a logo-and-description grid for the eight
supported services, and a Support/Credits/License footer. Sources
eight official service logos into docs/logos/.
~305 → ~200 lines.
* docs(readme): trim Support section and drop inaccurate claims
The previous Support copy claimed sponsorship "funds upstream spec
maintenance" — Tsarr doesn't maintain those specs (the Servarr team
does). Cut to a single honest line.
* docs(vhs): add disposable recording-stack docker compose
Reproducible 8-service rig for recording the README's VHS demos without
touching a real homelab. Includes an extract-keys.sh helper that pulls
auto-generated API keys from the *arr containers and prints a paste-
ready Tsarr config. qBittorrent and Jellyseerr still need a one-time
web UI step (documented in the README).
* fix(qbittorrent): support qBT v5 cookie and response shape
qBT 5.x changed two things that broke the client:
- Successful login returns HTTP 204 with an empty body (4.x returned
200 + "Ok."); the strict text-equality check rejected valid logins.
- The session cookie was renamed from `SID` to `QBT_SID_<port>`, but
the generated SDK still emits `Cookie: SID=...` on every request.
Capture the actual cookie name at login and rewrite outgoing Cookie
headers to use it. Both qBT 4.x and 5.x are now supported.
* docs(vhs): render hero + workflow demos and refine recording stack
Embed rendered demos and finalize the tape sources used to produce
them. The hero tape ends on `tsarr radarr profile list --table` so
the second beat shows real seeded data instead of an empty library.
The workflow tape switches to cross-service searches (radarr movie
search + sonarr series search) — same predictable command shape
across services, in 6 seconds. Both tapes prepend a local
.recording-bin to PATH so they exercise the in-repo source via a
small shim, not whatever global tsarr happens to be installed.
Other recording-stack tweaks: pin readarr to a versioned arm64-
compatible tag and add a note about local-only port overrides.
Gitignore .tsarr.json (per-project secrets) and .recording-bin/.
* docs(vhs): focus hero on doctor alone
Drop the second `profile list` beat from the hero tape — it scrolled
the `> tsarr doctor` command line off the top of the visible terminal,
so anyone landing mid-loop only saw a stray profile table without
context. The hero is now ~7s of pure doctor: type the command, pause,
8 ✓ services roll out, hold on the result. The doctor command stays
visible at the top throughout.
* docs(vhs): bring back multi-command hero with clear between beats
Restore the original doctor + profile list flow and add a movie
search beat — three commands total. Insert `clear` between each
so every command's prompt line stays anchored at the top of the
visible terminal instead of scrolling away when the next output
prints. Each beat: type, brief pause, run, hold on result.
* docs(readme): drop redundant logos/affiliation disclaimer
The Credits section already attributes upstream projects. The
disclaimer was bloat under the supported-services table.
* docs(vhs): prune leftover recording infrastructure
The recording-stack/ docker-compose rig and the docs/vhs/README.md
were scaffolding for the initial recording session, not something
contributors need long-term. Drop both — the two .tape files keep
their one-line render comment at the top, which is all anyone needs
to regenerate the GIFs against their own *arr stack.
docs/vhs/ is now just hero.gif, hero.tape, workflow.gif, workflow.tape.1 parent d98c935 commit 9a77293
17 files changed
Lines changed: 276 additions & 241 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
107 | 107 | | |
108 | 108 | | |
109 | 109 | | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
110 | 116 | | |
111 | 117 | | |
112 | 118 | | |
| |||
0 commit comments