diff --git a/README.md b/README.md index 7b69aee..f041962 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # keab -a very smol multi-threaded image compression utility written in rust , using turbojpeg and image library :> +a very smol multi-threaded image compression utility written in rust , using `turbojpeg` and `image-rs` library ### why -i am lazy +am lazy ### usage @@ -12,3 +12,10 @@ download the binaries from the releases page ```shell ./keab --folder path/to/image/folder --quality 10 --subsamp 422 ``` +*note: this program will run on all threads* + +|options|what is it| +|---|---| +|`folder`|the folder with the pictures you want to compress| +|`quality`|compression quality| +|`subsamp`|chroma subsampling i.e 422 for 4:2:2|