about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorgennyble <gen@nyble.dev>2024-06-10 17:29:09 -0500
committergennyble <gen@nyble.dev>2024-06-10 17:29:09 -0500
commit5a0e9ec5fb15e7e015249623540fc26c1984d5e2 (patch)
tree1a5d2eb8055e6f50ac11563d24867922d9531d83 /README.md
parent9b7650d6c089285949892ef12ce2ccd1c74285cb (diff)
downloadcolorsquash-5a0e9ec5fb15e7e015249623540fc26c1984d5e2.tar.gz
colorsquash-5a0e9ec5fb15e7e015249623540fc26c1984d5e2.zip
Bring readme into modernity
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index 3601c3a..f0e33b0 100644
--- a/README.md
+++ b/README.md
@@ -13,12 +13,17 @@ and takes the top N colours that are sufficiently different.
 
 [^1]: [wikipedia: color quantization](https://en.wikipedia.org/wiki/Color_quantization)
 
-**features**
+**library 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.
 
+**colour selection algorithms**
+
+*`Sorsel`* - sorts colors most to least frequent and then picks the top colours that are different enough than the colours already picked.  
+*`KMeans`* - use k-means clustering to select the palette.  
+*`HighestBits`* - bit-shift the color components until all of the colors fit in the palette.
+
 ### squash
 A CLI tool to quantize colours :D