about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorgennyble <gen@nyble.dev>2024-01-14 07:33:52 -0600
committergennyble <gen@nyble.dev>2024-01-14 07:33:52 -0600
commit88656a81d8e1480c3e37a3402901525aee1a596c (patch)
tree3263cc0726b8b05981c11083473e271a2f82d0c8 /README.md
parent2b3181f3c4675d744338f497564faa00bc5d76db (diff)
downloadcolorsquash-88656a81d8e1480c3e37a3402901525aee1a596c.tar.gz
colorsquash-88656a81d8e1480c3e37a3402901525aee1a596c.zip
allow choosing selection algorithm
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index ef9ce84..3601c3a 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,12 @@ and takes the top N colours that are sufficiently different.
 
 [^1]: [wikipedia: color quantization](https://en.wikipedia.org/wiki/Color_quantization)
 
+**features**
+
+**`kmeans`** - use kmeans for palette selection instead of sort & select.  
+**`gifed`** - adds the `Squasher::palette_gifed()` method allowing you to
+directly get a gifed's Palette struct.
+
 ### squash
 A CLI tool to quantize colours :D