From 5fee19838c90d3d75f6a8c7b0cbb4da8b6762ff5 Mon Sep 17 00:00:00 2001
From: kj_sh604
Date: Sun, 15 Mar 2026 13:00:31 -0400
Subject: refactor: update docs

---
 README.md | 73 +++++++++++++++++++++++++++++++++++++--------------------------
 1 file changed, 43 insertions(+), 30 deletions(-)

diff --git a/README.md b/README.md
index ff0aacf..5c33777 100644
--- a/README.md
+++ b/README.md
@@ -11,29 +11,48 @@ a GTK3 color scheme generator inspired by classic Agave, rewritten in Go
 
 ## features
 
-- Agave-style scheme generator with:
-	- Triads
-	- Complements
-	- Split Complements
-	- Tetrads
-	- Analogous
-	- Monochromatic
-- large scheme preview cards showing hex, rgb, and hsv
-- lighten, darken, saturate, desaturate quick actions
-- color history navigation (back/forward)
-- random color generation
-- palette browser with built-in web-safe, tango, and visibone-style sets
-- favorites panel with add/remove/clear
-- favorites export to GIMP `.gpl` (`~/.config/kjagave-favorites.gpl`)
-- clipboard copy/paste for hex colors
-- screen picker support on X11 (`xcolor` or `grabc`)
+- agave-style scheme generator modes:
+	- triads
+	- complements
+	- split complements
+	- tetrads
+	- analogous
+	- monochromatic
+- compact top swatch cards with centered overlay metadata:
+	- hex
+	- rgb
+	- hsv
+- dynamic overlay text contrast (light/dark text based on background luminance)
+- toolbar actions: back, forward, random, lighten, darken, saturate, desaturate, paste
+- click a top swatch to promote it to the active base color
+- right-click on top swatches and palette swatches to copy:
+	- hex
+	- hsv
+	- rgb
+- 12 built-in palettes:
+	- Web-safe (legacy)
+	- Material Design
+	- Tailwind CSS
+	- Flat UI
+	- Pastel
+	- Nord
+	- Dracula
+	- Solarized
+	- Gruvbox
+	- One Dark
+	- Monokai
+	- KiJiSH Dark Pastel Terminal
+- favorites panel with add/remove/rename/clear
+- clipboard copy/paste support
+- screen picker support on X11 via `xcolor` or `grabc`
+- persisted state in `~/.config/kjagave.json` (last color, scheme, palette, favorites)
 
 ## requirements
 
 - go 1.21 or higher
 - gtk3 development libraries
-- `gotk3` go bindings
-- `xcolor`
+- `gotk3` Go bindings
+- optional for pick-from-screen: `xcolor` or `grabc`
 
 ## installation
 
@@ -44,15 +63,11 @@ cd archlinux
 makepkg -si
 ```
 
-see `archlinux/README.md` for more details.
-
 ### manual build
 
 ```sh
 cd src
-go mod download
-go mod download github.com/gotk3/gotk3
-go build -o kjagave main.go
+go build -o kjagave .
 ```
 
 ## running
@@ -63,10 +78,8 @@ go build -o kjagave main.go
 
 ## usage
 
-1. pick a base color with the color button, hex entry, palette list, or screen picker
-2. choose a scheme type from the combo box
-3. click any preview card to promote that scheme color to the active base color
-4. use toolbar actions (`Back`, `Forward`, `Random`, `Lighten`, `Darken`, `Saturate`, `Desaturate`, `Paste`) to iterate quickly
-5. add colors to favorites with `+`, remove with `-`, and export favorites with `Export GPL`
-
-state and favorites are stored in `~/.config/kjagave.json`.
+1. pick a base color with the color button, hex entry, palette swatches, or screen picker
+2. choose a scheme type
+3. click a preview swatch to make it the active base color
+4. right-click a swatch to copy hex/hsv/rgb
+5. use favorites controls (`+`, `-`, rename, clear) to manage saved colors
\ No newline at end of file
-- 
cgit v1.2.3