diff options
author | gennyble <gen@nyble.dev> | 2023-10-09 20:28:52 -0500 |
---|---|---|
committer | gennyble <gen@nyble.dev> | 2023-10-09 20:28:52 -0500 |
commit | 6c2108ebbe8402baa8216d4db92e0444875415d1 (patch) | |
tree | e25062833f9fd89f2344a6589a4af8d8f33b75fc /README.md | |
parent | 3ad73998fe7bbb146aa124bc22729afe98d77c4c (diff) | |
download | colorsquash-6c2108ebbe8402baa8216d4db92e0444875415d1.tar.gz colorsquash-6c2108ebbe8402baa8216d4db92e0444875415d1.zip |
add note about tolerance tuning
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md index fa69edc..ef9ce84 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,11 @@ | - | - | |  |  | -colorsquash is a colour quantization[^1] crate and algorithm. +> [!IMPORTANT] +> This crate isn't *quite* ready yet. There's some tuning and research to be done while selecting the palette. To get the best results you'll likely have to do some trial and error with the tolerance for your specific application. + +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. |