Rewrite README to reflect all v0.1.0-v0.1.3 features

2026-04-04 20:50:30 -05:00 · 2026-04-04 20:50:30 -05:00 · bde1465af4
commit bde1465af4
parent 4f8b703132
1 changed files with 94 additions and 34 deletions
--- a/README.md
+++ b/README.md
@ -1,6 +1,8 @@
 # booru-viewer

-Local desktop application for browsing, searching, and favoriting images from booru-style imageboards.
+Local desktop app for browsing, searching, and saving images from booru-style imageboards.
+
+Qt6 GUI, cross-platform (Linux + Windows), fully themeable.

 ## Screenshots

@ -20,21 +22,62 @@ Supports custom styling via `custom.qss` — see [Theming](#theming).

 ## Features

- Supports Danbooru, Gelbooru, Moebooru, and e621
+### Browsing
+- Supports **Danbooru, Gelbooru, Moebooru, and e621**
 - Auto-detect site API type — just paste the URL
- Tag search with autocomplete and history
- Thumbnail grid with image/video preview (zoom, pan, GIF animation)
- Favorites with folder organization
- Save to library, drag-and-drop, multi-select bulk operations
- Custom CSS theming (native OS look by default)
- Cross-platform: Linux and Windows
+- Tag search with autocomplete, history dropdown, and saved searches
+- Rating and score filtering (server-side `score:>=N`)
+- Blacklisted tags (appended as negatives)
+- Thumbnail grid with keyboard navigation
+
+### Preview
+- Image viewer with zoom (scroll wheel, `+`/`-`), pan (drag), and reset (middle click)
+- GIF animation, Pixiv ugoira auto-conversion (zip to animated GIF)
+- Video playback (MP4, WebM) with play/pause, seek, volume, mute, and seamless looping
+- Info panel with post details, clickable tags, and filetype
+
+### Slideshow Mode
+- Right-click preview → "Slideshow Mode" for fullscreen viewing
+- Arrow keys / `h`/`j`/`k`/`l` navigate posts (including during video playback)
+- `,` / `.` seek 5 seconds in videos, `Space` toggles play/pause
+- Toolbar with Favorite and Save/Unsave toggle buttons showing current state
+- `F11` toggles fullscreen/windowed, `Ctrl+H` hides all UI
+- Bidirectional sync — clicking posts in the main grid updates the slideshow
+- Page boundary navigation — past the last/first post loads next/prev page
+
+### Favorites & Library
+- Favorite posts, organize into folders
+- Save to library (unsorted or per-folder), drag-and-drop thumbnails as files
+- Multi-select (Ctrl/Shift+Click, Ctrl+A) with bulk actions
+- Bulk context menus in both Browse and Favorites tabs
+- Unsave from Library available in grid, preview, and slideshow
+- Import/export favorites as JSON
+
+### Search
+- Inline history dropdown inside the search bar
+- Saved searches with management dialog
+- Click empty search bar to open history
+- Session cache mode clears history on exit (keeps saved searches)

 ## Install

+### Linux
+
 ```sh
 pip install -e .
+booru-viewer
 ```

+Or run directly: `python -m booru_viewer.main_gui`
+
+### Windows
+
+Download `booru-viewer.exe` from [Releases](https://git.pax.moe/pax/booru-viewer/releases).
+
+For WebM video playback, install **VP9 Video Extensions** from the Microsoft Store.
+
+Windows 10 dark mode is automatically detected and applied.
+
 ### Dependencies

 - Python 3.11+
@ -42,39 +85,47 @@ pip install -e .
 - httpx
 - Pillow

-## Usage
+## Keybinds

-```sh
-booru-viewer
-```
-
-Or run directly:
-
-```sh
-python -m booru_viewer.main_gui
-```
-
-### Windows
-
-Download `booru-viewer.exe` from [Releases](https://git.pax.moe/pax/booru-viewer/releases).
-
-For WebM video playback, install **VP9 Video Extensions** from the Microsoft Store.
-
-### Keybinds
+### Grid

 | Key | Action |
 |-----|--------|
-| Click / Arrow keys | Select and preview |
-| `h`/`j`/`k`/`l` | Grid navigation |
+| Arrow keys / `h`/`j`/`k`/`l` | Navigate grid |
 | `Ctrl+A` | Select all |
 | `Ctrl+Click` / `Shift+Click` | Multi-select |
-| Scroll wheel | Zoom in preview |
-| Middle click | Reset view |
-| Left / Right | Previous / next post |
-| `Ctrl+P` | Privacy screen |
-| `F11` | Fullscreen |
+| `Home` / `End` | Jump to first / last |
 | Right click | Context menu |

+### Preview
+
+| Key | Action |
+|-----|--------|
+| Scroll wheel / `+`/`-` | Zoom |
+| Middle click / `0` | Reset view |
+| Left / Right | Previous / next post |
+| `,` / `.` | Seek 5s back / forward (video) |
+| `Space` | Play / pause (video) |
+| Right click | Context menu (favorite, save, slideshow) |
+
+### Slideshow
+
+| Key | Action |
+|-----|--------|
+| Arrow keys / `h`/`j`/`k`/`l` | Navigate posts |
+| `,` / `.` | Seek 5s (video) |
+| `Space` | Play / pause (video) |
+| `F11` | Toggle fullscreen / windowed |
+| `Ctrl+H` | Hide / show UI |
+| `Escape` / `Q` | Close slideshow |
+
+### Global
+
+| Key | Action |
+|-----|--------|
+| `Ctrl+P` | Privacy screen |
+| `F11` | Toggle fullscreen |
+
 ## Adding Sites

 File > Manage Sites. Enter a URL, click Auto-Detect, and save.
@ -88,7 +139,15 @@ The app uses your OS native theme by default. To customize, create `custom.qss`
 - **Linux**: `~/.local/share/booru-viewer/custom.qss`
 - **Windows**: `%APPDATA%\booru-viewer\custom.qss`

-A green-on-black theme template is available in Settings > Theme > Create from Template.
+A template is available in Settings > Theme > Create from Template.
+
+## Settings
+
+- **General** — page size, thumbnail size, default rating/score, file dialog platform
+- **Cache** — max cache size, auto-evict, clear cache on exit (session-only mode)
+- **Blacklist** — tag blacklist with import/export
+- **Paths** — data directory, cache, database locations
+- **Theme** — custom.qss editor, template generator, CSS guide

 ## Data Locations

@ -97,6 +156,7 @@ A green-on-black theme template is available in Settings > Theme > Create from T
 | Database | `~/.local/share/booru-viewer/booru.db` | `%APPDATA%\booru-viewer\booru.db` |
 | Cache | `~/.local/share/booru-viewer/cache/` | `%APPDATA%\booru-viewer\cache\` |
 | Library | `~/.local/share/booru-viewer/saved/` | `%APPDATA%\booru-viewer\saved\` |
+| Theme | `~/.local/share/booru-viewer/custom.qss` | `%APPDATA%\booru-viewer\custom.qss` |

 ## License