about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorgennyble <gen@nyble.dev>2023-10-09 20:20:16 -0500
committergennyble <gen@nyble.dev>2023-10-09 20:20:16 -0500
commit3ad73998fe7bbb146aa124bc22729afe98d77c4c (patch)
tree6840a9bc9efc682df8133ca53274cffcb3654a86 /README.md
parentdb422e0c983d7543d4d5e742630b29e36c55cbd4 (diff)
downloadcolorsquash-3ad73998fe7bbb146aa124bc22729afe98d77c4c.tar.gz
colorsquash-3ad73998fe7bbb146aa124bc22729afe98d77c4c.zip
some docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 8 insertions, 9 deletions
diff --git a/README.md b/README.md
index 288a923..fa69edc 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,11 @@
-Colorsquash is a colour quantization[^1] crate and algorithm.
-At it's core, it sorts the unique colours that appear in an image
-and selects the most frequent that are sufficiently different.
-
-To put it more clearly:  
-The most frequent colour is always selected and placed into the palette.
-If the second most frequent colour is *different enough*, it will be selected
-as well. If it's not, it is skipped and the third one is tried. This continues
-until it selects the necessary amount of colours.
+| 24bit RGB | 256 color Indexed|
+| - | - |
+| ![a small dog laying on a concrete floor in an industrial building](https://nyble.dev/colorsquash/astro.jpg) | ![the same image in 256 color. there are some visual differences, but the two images look very similar](https://nyble.dev/colorsquash/astro_squash.gif) |
+
+colorsquash is a colour quantization[^1] crate and algorithm.  
+At it's core, it sorts the colors of an image by how frequently
+they appear, greatest to least. It then goes through those colours
+and takes the top N colours that are sufficiently different.
 
 [^1]: [wikipedia: color quantization](https://en.wikipedia.org/wiki/Color_quantization)