From 574c355f82027351dc59ad18bc23e8c407baad15 Mon Sep 17 00:00:00 2001 From: Gabriel Kaszewski Date: Sun, 15 Mar 2026 19:55:22 +0100 Subject: [PATCH] docs: add compositor setup section and screenshot placeholder --- README.md | 21 ++++++++++++++++++--- docs/screenshot.png | 0 2 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 docs/screenshot.png diff --git a/README.md b/README.md index 3fe2144..e28e8c4 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,7 @@ A lightweight, GPU-accelerated command palette for Linux (Wayland/X11). Zero Electron — every pixel rendered via WGPU. Async search that never blocks the UI. -``` -[screenshot placeholder] -``` +![k-launcher](docs/screenshot.png) ## Quick Start @@ -24,6 +22,23 @@ cargo build --release | `Enter` | Launch selected | | `Escape` | Close | +## Compositor Setup + +k-launcher uses a normal window; configure your compositor to float it. + +**Hyprland** (`~/.config/hypr/hyprland.conf`): +``` +windowrule = float, ^(k-launcher)$ +windowrule = center, ^(k-launcher)$ +bind = SUPER, Space, exec, k-launcher +``` + +**Sway** (`~/.config/sway/config`): +``` +for_window [app_id="k-launcher"] floating enable, move position center +bindsym Mod4+space exec k-launcher +``` + ## Built-in Plugins | Trigger | Plugin | Example | diff --git a/docs/screenshot.png b/docs/screenshot.png new file mode 100644 index 0000000..e69de29