From 3870cb25e188825f8474901d5aa7a8ac7a5ed6c9 Mon Sep 17 00:00:00 2001 From: Joby Elliott Date: Wed, 30 Sep 2020 12:21:05 -0600 Subject: [PATCH] Update README.md --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index c13d427..68943d9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ # image-transform + A tightly-focused library for performing a very limited set of simple image transformations. This library's purpose is to eschew the standard kitchen sink approach to PHP image libraries in favor of high performance, wide driver support, and a dead simple API. + +## Roadmap + +This library is under active development, and until a 1.0 release is made you should expect it to potentially change its API and functionality. Possibly **drastically**. That said, I *do* have use of this thing for work, so I'm probably going to be working pretty dang hard on it, and hope to have a stable release by about November of 2020. + +### Drivers + +A 1.0 release will not be made until the following drivers are available and solidly tested: + +* GD +* Imagick +* Gmagick +* GmagickCLI + +### Transforms + +A 1.0 release will be made available once the following transforms are available and solidly tested across all drivers: + +* rotate (in 90 degree increments) +* mirror-h +* mirror-v +* max-width +* max-height +* fit (basically an alias for max-width and max-height) +* cover +* crop +* cover-crop (convenience transform, combining cover and crop, useful for thumbnails) + +The following transforms are also on my mind as possibilities, but may or may not make it into 1.0: + +* grayscale +* colorize (needs to function consistently though) +* overlay (i.e. for watermarking)