From 79a43b9ab3e07d3fdff786b3160bb3a7925ad9fd Mon Sep 17 00:00:00 2001 From: nick Date: Mon, 21 Sep 2026 19:07:48 +1200 Subject: [PATCH] docs: README for v0.2.1 (stats cache, sticky library controls, scan confirmations) --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 5f1dc71..f1f88b0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Native Android (Kotlin / Jetpack Compose / Material 3) client for the Tdarr server v2.2x+ /api/v2 JSON API. -**Current release:** v0.2.0 — full release notes ship on its entry on the +**Current release:** v0.2.1 — full release notes ship on its entry on the [Releases page](https://git.trevena.info/nick/Trafero/releases). > **Installing a release APK over a debug build?** They are signed with @@ -20,22 +20,21 @@ Release builds need the local dev keystore — see [`keystore/README.md`](keysto ## Install & test adb install -r app/build/outputs/apk/debug/app-debug.apk -## Features (v0.2.0) +## Features (v0.2.1) - Connection wizard: custom URL (scheme/port normalization, default :8265), auth mode None / API key (x-api-key) / username+password (bearer token), self-signed TLS toggle, live test probe, multi-server switcher. - Jobs: running workers (progress/fps/ETA, cancel), staged queue (approve/reject), history (file filter), error stacks (table1/2/3). -- Library: search + per-library filter + sort, paged file cards, detail bottom sheet (streams from ffprobe, plugin output, re-check). +- Library: sticky control strip pinned above the search (per-library watch toggle, scan new / full scan), search + per-library filter + sort, paged file cards, detail bottom sheet (streams from ffprobe, plugin output, re-check). Scan buttons confirm first; full scan warns explicitly (wipes DB + re-queues everything) and offers the safe scan-for-new-files fallback. - Nodes: pause/resume, worker limit +/-, kill worker, queue depths. -- Stats: server info, CPU/mem, totals, space saved, transcode/health donuts, codec mix. +- Stats: server info, CPU/mem, totals, space saved, transcode/health donuts, codec mix; opens instantly from a cached per-server snapshot while refreshing in the background. - Logs: server log with filter + follow. -- Settings: pause-all-nodes & ignore-schedules, libraries (watch toggle, scan new / full scan), server CRUD. +- Settings: pause-all-nodes & ignore-schedules, server CRUD. - Flows: read-only flow-plugin catalog (inputs/filters/actions/variables/outputs). - Polling interval picker (Off/5s/15s/30s/1m/5m) in app bar; Material You dynamic color, dark & light. -## v0.2.0 changes (slow-connection resilience) -- Per-server **timeout** field and **"Slow connection"** mode (doubles all timeouts) in the server editor; defaults 20 s connect / 90 s read. -- Read-style/polling calls auto-retry twice (2 s / 5 s backoff) on network failures only — user-triggered mutations are never repeated. -- Screens keep their last good data on transient failures and show a slim **"reconnecting…"** chip; full error banners are reserved for no-data, auth, or server errors. After 3 consecutive poll failures a screen backs off to a 60 s cadence. -- OkHttp keep-alive pool is evicted on app resume so stale NAT/LAN sockets can't cause phantom timeouts. +## v0.2.1 changes +- **Instant Stats.** The last-good stats snapshot is cached per server; the Stats tab opens with the previous numbers immediately (small "Cached - updated …" hint) and refreshes in the background — no more blank screen while the first poll runs, and cold starts on flaky links keep showing last-known data behind the reconnecting chip. +- **Library controls on the Library screen.** Watch-folder toggles and Scan new / Full scan moved out of More → Settings into a compact sticky strip pinned above the library search; the file list scrolls beneath it. +- **Scan confirmations.** Scan new asks before running; Full scan shows a destructive-action warning (wipes the database, re-queues the library for health checks + transcoding) with a one-tap Scan-new fallback. ## Earlier changes Full history lives in [`PREVIOUS_HISTORY.md`](PREVIOUS_HISTORY.md); each release on the Releases page carries its own notes plus a `Trafero--changes.md` asset. @@ -45,7 +44,7 @@ Full history lives in [`PREVIOUS_HISTORY.md`](PREVIOUS_HISTORY.md); each release - Flow editing, node/server restart, updater and disk-delete actions intentionally not exposed (agreed scope / safety). ## Architecture -Single :app module. data/api/TdarrClient (OkHttp, {data:{...}} envelope, TraferoApiException kinds: AUTH/NETWORK/SERVER/LEGACY), data/repo/TraferoRepo (typed parsing), DataStore server profiles, manual DI (AppContainer), Compose screens under ui/screens/*, pollLoop() helper for per-screen refresh. +Single :app module. data/api/TdarrClient (OkHttp, {data:{...}} envelope, TraferoApiException kinds: AUTH/NETWORK/SERVER/LEGACY), data/repo/TraferoRepo (typed parsing), DataStore server profiles + per-server stats snapshots, manual DI (AppContainer), Compose screens under ui/screens/*, pollLoop() helper for per-screen refresh. ## Reference OpenAPI 2.0 spec of the target API vendored at app/src/main/assets/api-docs-v2.json (served live by any Tdarr server at /api/v2/public/api-docs/json).