Update README: stability table, HA hook example, v0.1.0 release notes

Author: trevholliday

README.md

@@ -14,21 +14,36 @@
 </pre>
 </p>
 
-> **Work in progress.** Frostscribe is under active development and may be unstable until v1.0.0 is released. Expect rough edges.
-
 # Frostscribe
 
 A native macOS tool for ripping and preserving physical disc media to a local [Jellyfin](https://jellyfin.org), [Plex](https://plex.tv), or [Kodi](https://kodi.tv) library.
 
-Frostscribe wraps `makemkvcon` and `HandBrakeCLI` into a polished interactive CLI. Insert a disc, run `frostscribe rip`, confirm the title, and walk away. The encode worker handles the rest in the background.
+Frostscribe wraps `makemkvcon` and `HandBrakeCLI` into a polished interactive CLI and menu bar app. Insert a disc, confirm the title, and walk away. The background worker handles encoding while you use your Mac normally.
+
+---
+
+## Stability
+
+| Feature | Status |
+|---|---|
+| Movie ripping — Vigil Mode | ✅ Stable |
+| Movie encoding (H.265, hardware) | ✅ Stable |
+| Background worker (rip + encode) | ✅ Stable |
+| Menu bar app + GUI rip flow | ✅ Stable |
+| CLI rip flow | ✅ Stable |
+| Event hooks (Home Assistant, etc.) | ✅ Stable |
+| TV show ripping | ⚠️ Functional, not thoroughly tested |
+| AutoScribe (auto-rip without prompting) | ⚠️ Experimental |
+
+> TV show ripping works end-to-end but has not been tested across a wide variety of discs and edge cases. Episode numbering and season path formatting should be verified for your media server.
 
 ---
 
 ## Requirements
 
 - macOS 14 or later
 - [MakeMKV](https://makemkv.com) — download and install from makemkv.com
-- [HandBrake](https://handbrake.fr) — `HandBrakeCLI` must be in your `$PATH` or configured via `frostscribe init`
+- [HandBrake](https://handbrake.fr) CLI:
 
 ```bash
 brew install handbrake
@@ -45,14 +60,20 @@ brew tap trevholliday/frostscribe
 brew install frostscribe
 ```
 
+This installs the `frostscribe` CLI, `frostscribe-worker` background daemon, and registers the LaunchAgent so the worker starts automatically on login.
+
+**Menu bar app:**
+
+Download `FrostscribeUI.app` from the [latest release](https://github.com/trevholliday/frostscribe/releases/latest) and move it to `/Applications`.
+
 **Build from source:**
 
 ```bash
 git clone https://github.com/trevholliday/frostscribe
 cd frostscribe
 swift build -c release
-cp .build/release/frostscribe /usr/local/bin/
-cp .build/release/frostscribe-worker /usr/local/bin/
+sudo cp .build/release/frostscribe /usr/local/bin/
+sudo cp .build/release/frostscribe-worker /usr/local/bin/
 ```
 
 ---
@@ -67,62 +88,43 @@ frostscribe init
 
 This creates `~/Library/Application Support/Frostscribe/config.json` with your output directories, media server selection, and optional API keys.
 
-Install and start the background encode worker:
+Then install and start the background worker:
 
 ```bash
-cp /usr/local/bin/frostscribe-worker /usr/local/bin/frostscribe-worker
+cp com.frostscribe.worker.plist ~/Library/LaunchAgents/
 launchctl load ~/Library/LaunchAgents/com.frostscribe.worker.plist
 ```
 
 **Why the worker runs as a launchd agent**
 
-Encoding is slow — a Blu-ray can take 30–90 minutes. The worker runs as a persistent background service managed by launchd so it survives terminal sessions, restarts after crashes, and starts automatically on login. It polls the encode queue every 10 seconds and processes jobs one at a time using VideoToolbox hardware encoding.
-
-The worker plist lives at `~/Library/LaunchAgents/com.frostscribe.worker.plist` and logs to `~/Library/Logs/Frostscribe/worker.log`.
-
-To stop the worker:
-
-```bash
-launchctl unload ~/Library/LaunchAgents/com.frostscribe.worker.plist
-```
-
-To restart it (e.g. after updating the binary):
+Encoding is slow — a Blu-ray can take 30–90 minutes. The worker runs as a persistent background service managed by launchd so it survives terminal sessions, restarts after crashes, and starts automatically on login. It polls the rip and encode queues and processes jobs one at a time using VideoToolbox hardware encoding.
 
-```bash
-launchctl kickstart -k gui/$(id -u)/com.frostscribe.worker
-```
+Logs: `~/Library/Logs/Frostscribe/worker.log`
 
 ---
 
 ## Usage
 
-### Rip a disc
+### Menu bar app (Vigil Mode)
 
-Insert a disc, then:
-
-```bash
-frostscribe rip
-```
+Open **FrostscribeUI** from `/Applications`. The snowflake icon lives in your menu bar and shows rip/encode status at a glance.
 
-Frostscribe will:
-1. Scan the disc and display all titles with duration, chapters, size, and audio tracks
-2. Look up the title on TMDB (if a key is configured)
-3. Prompt you to confirm the output path
-4. Rip the selected title to your temp directory
-5. Add an encode job to the queue
-6. Eject the disc
+Click **Rip Disc** to open the guided rip flow:
 
-The background worker picks up the job and encodes it to your media library using VideoToolbox hardware encoding (H.265).
+1. Disc scans automatically
+2. Search TMDB to identify the title (or enter manually)
+3. Select the disc title and audio tracks
+4. Confirm output path
+5. The rip runs in the background worker — closing the app will not interrupt it
+6. Encoding begins automatically when the rip finishes
+7. Push notification fires on completion (configure via `event_hook`)
 
-### Menu bar app
+**Vigil Mode** (default) means ripping is guided and interactive. Disable it in Settings to enable **AutoScribe**, which rips any inserted disc automatically without prompting.
 
-The **FrostscribeUI** menu bar app lives in your menu bar permanently. It shows rip and encode status at a glance, lets you open a full GUI rip flow window ("Rip Disc"), and manage settings.
-
-**Vigil Mode** (default: on) means you are present — ripping is guided and interactive. Disabling Vigil Mode activates **AutoScribe**, which automatically rips any inserted disc without prompting. AutoScribe requires confirmation to enable in Settings.
-
-### Check status
+### CLI
 
 ```bash
+frostscribe rip          # Guided interactive rip session
 frostscribe status       # Current rip and encode status
 frostscribe queue        # Encode queue with per-job progress
 ```
@@ -176,9 +178,28 @@ TV Shows/Breaking Bad/Season01/Breaking Bad S01E01.mkv
 | `makemkv_key` | No | MakeMKV registration key (trial mode without it) |
 | `makemkv_bin` | No | Full path to `makemkvcon` (searched in `$PATH` if empty) |
 | `handbrake_bin` | No | Full path to `HandBrakeCLI` (searched in `$PATH` if empty) |
-| `event_hook` | No | Shell command executed on lifecycle events. Receives `FROSTSCRIBE_EVENT` (`rip_complete`, `encode_complete`, `encode_failed`), `FROSTSCRIBE_TITLE`, and `FROSTSCRIBE_BODY` as environment variables. Use this to send notifications via Home Assistant, Slack, Pushover, etc. |
-| `vigil_mode` | No | `true` = Vigil Mode (interactive, user-guided — default). `false` = AutoScribe (auto-rips inserted discs without prompting) |
-| `select_audio_tracks` | No | Prompt to choose which audio tracks to include before ripping (default: `false`) |
+| `event_hook` | No | Shell command executed on lifecycle events. Receives `FROSTSCRIBE_EVENT` (`rip_complete`, `encode_complete`, `encode_failed`), `FROSTSCRIBE_TITLE`, and `FROSTSCRIBE_BODY` as environment variables. |
+| `vigil_mode` | No | `true` = Vigil Mode (interactive, default). `false` = AutoScribe (auto-rips without prompting) |
+| `select_audio_tracks` | No | Prompt to choose audio tracks before ripping (default: `false`) |
+| `quality_dvd` | No | HandBrake RF quality for DVD (default: `80`) |
+| `quality_bluray` | No | HandBrake RF quality for Blu-ray (default: `70`) |
+| `quality_uhd` | No | HandBrake RF quality for UHD Blu-ray (default: `70`) |
+
+### Event hook example (Home Assistant push notification)
+
+```bash
+python3 -c "
+import urllib.request, json, os
+urllib.request.urlopen(
+  urllib.request.Request(
+    'http://localhost:8123/api/services/notify/mobile_app_YOUR_DEVICE',
+    json.dumps({'title': os.environ.get('FROSTSCRIBE_TITLE',''),
+                'message': os.environ.get('FROSTSCRIBE_BODY','')}).encode(),
+    {'Authorization': 'Bearer YOUR_HA_TOKEN', 'Content-Type': 'application/json'}
+  ), timeout=5
+)
+"
+```
 
 ---