From 4291e9b14473703023b23ead5d61f3789246b2d9 Mon Sep 17 00:00:00 2001 From: Aria Date: Sat, 15 Mar 2025 00:17:35 +1100 Subject: [PATCH] Add README --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f9eb555 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Remote Image Compression + +An API for compressing an image on the server. main use case is using AVIF at it's slowest preset while away from home + +## Features: + +- formats: + - [x] jpeg + - [x] avif + - [ ] jpegxl + - [ ] webp + - [ ] png (mainly for using `oxipng -o max`) + +- Interface: + - [ ] Image upload + - [ ] Compress via image URL + +- Backend + - [X] single executable (for the API server, still need the requirements bellow) + - [ ] docker image + - [X] Linux support + - [ ] Windows support + + ❔ Mac Support + +### Current requirements: + +- magick ([ImageMagick](https://archlinux.org/packages/?name=imagemagick)) +- cjpeg ([mozjpeg](https://aur.archlinux.org/packages/mozjpeg) or [libjpeg-turbo](https://archlinux.org/packages/extra/x86_64/libjpeg-turbo/)) +- avifenc ([libavif](https://archlinux.org/packages/extra/x86_64/libavif/)) \ No newline at end of file