diff --git a/README.md b/README.md index c4a51827..f59a7715 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,10 @@ Local stats dashboard — watch time, anime library, vocabulary growth, mining t Browse sibling episode files and the active mpv queue in one overlay modal. Open it with `Ctrl+Alt+P` to append episodes from the current directory, jump to queued items, remove entries, or reorder the playlist without leaving playback. +
+ Stats dashboard showing watch time, cards mined, streaks, and tracking data +
+
### Integrations @@ -106,12 +110,12 @@ Browse sibling episode files and the active mpv queue in one overlay modal. Open ## Requirements -| | Required | Recommended | Optional | -| -------------- | --------------------------------------- | ---------------------------------------- | ----------------------------------------------------------- | -| **Player** | [`mpv`](https://mpv.io) with IPC socket | — | — | -| **Processing** | — | `ffmpeg` (audio clips & screenshots) | `mecab` + `mecab-ipadic` (annotation POS filtering), `guessit` (AniSkip), `alass` / `ffsubsync` (subtitle sync) | -| **Media** | — | — | `yt-dlp`, `chafa`, `ffmpegthumbnailer` | -| **Selection** | — | — | `fzf` / `rofi` | +| | Required | Recommended | Optional | +| -------------- | --------------------------------------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------- | +| **Player** | [`mpv`](https://mpv.io) with IPC socket | — | — | +| **Processing** | — | `ffmpeg` (audio clips & screenshots) | `mecab` + `mecab-ipadic` (annotation POS filtering), `guessit` (AniSkip), `alass` / `ffsubsync` (subtitle sync) | +| **Media** | — | — | `yt-dlp`, `chafa`, `ffmpegthumbnailer` | +| **Selection** | — | — | `fzf` / `rofi` | > [!TIP] > `ffmpeg` is not strictly required to run SubMiner, but without it audio clips and screenshots will not be attached to Anki cards. Most users will want it installed. @@ -260,7 +264,7 @@ subminer stats -b # stats daemon in background subminer stats -s # stop background stats daemon ``` -On **Windows**, the `subminer` script must be run with `bun run subminer` (e.g. `bun run subminer video.mkv`). The recommended alternative is the **SubMiner mpv** shortcut (created during setup) or `SubMiner.exe --launch-mpv`. Drag a video file onto the shortcut to play it, or double-click it to open mpv with SubMiner's defaults. +On **Windows**, the `subminer` script must be run with `bun run subminer` (e.g. `bun run subminer video.mkv`). The recommended alternative is the **SubMiner mpv** shortcut (created during setup) or `SubMiner.exe --launch-mpv`. Drag a video file onto the shortcut to play it, or double-click it to open mpv with SubMiner's defaults. ## Documentation diff --git a/docs-site/public/screenshots/playlist-browser.png b/docs-site/public/screenshots/playlist-browser.png new file mode 100644 index 00000000..7ca69526 Binary files /dev/null and b/docs-site/public/screenshots/playlist-browser.png differ diff --git a/docs-site/public/screenshots/stats-overview.png b/docs-site/public/screenshots/stats-overview.png index fb4a2da8..381d0df7 100644 Binary files a/docs-site/public/screenshots/stats-overview.png and b/docs-site/public/screenshots/stats-overview.png differ