Skip to content

Commit

Permalink
Replace development feature list with caveats
Browse files Browse the repository at this point in the history
  • Loading branch information
olivervogel committed Jan 12, 2025
1 parent 4647fbd commit 4b1d4ee
Showing 1 changed file with 16 additions and 97 deletions.
113 changes: 16 additions & 97 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,101 +61,20 @@ $encoded = $image->toJpg();
$encoded->save('images/example.jpg');
```

## Development Status

The library is under development and not yet complete. Here is an overview of
the features that have already been implemented.

### Feature Status

| Feature | Status |
| - | - |
| ImageManager::read() ||
| ImageManager::create() ||
| ImageManager::animate() ||
| Image::width() ||
| Image::height() ||
| Image::size() ||
| Image::resize() ||
| Image::resizeDown() ||
| Image::scale() ||
| Image::scaleDown() ||
| Image::cover() ||
| Image::coverDown() ||
| Image::pad() ||
| Image::contain() ||
| Image::crop() ||
| Image::resizeCanvas() ||
| Image::resizeCanvasRelative() ||
| Image::trim() ||
| Image::place() ||
| Image::brightness() ||
| Image::contrast() ||
| Image::gamma() ||
| Image::colorize() ||
| Image::greyscale() ||
| Image::flip() ||
| Image::flop() ||
| Image::rotate() ||
| Image::orient() ||
| Image::blur() ||
| Image::sharpen() ||
| Image::invert() ||
| Image::pixelate() ||
| Image::reduceColors() ||
| Image::text() ||
| Image::fill() ||
| Image::drawPixel() ||
| Image::drawEllipse() ||
| Image::drawCircle() ||
| Image::drawLine() ||
| Image::drawRectangle() ||
| Image::drawPolygon() ||
| Image::drawBezier() ||
| Image::resolution() ||
| Image::setResolution() ||
| Image::exif() ||
| Image::pickColor() ||
| Image::pickColors() ||
| Image::colorspace() ||
| Image::setColorspace() ||
| Image::profile() ||
| Image::setProfile() ||
| Image::removeProfile() ||
| Image::blendingColor() ||
| Image::setBlendingColor() ||
| Image::blendTransparency() ||
| Image::isAnimated() ||
| Image::count() ||
| Image::sliceAnimation() ||
| Image::loops() ||
| Image::setLoops() ||
| Image::removeAnimation() ||
| Image::encode() ||
| Image::encodeByMediaType() ||
| Image::encodeByPath() ||
| Image::encodeByExtension() ||
| Image::save() ||
| Image::toJpeg() ||
| Image::toWebp() ||
| Image::toPng() ||
| Image::toGif() ||
| Image::toBitmap() ||
| Image::toAvif() ||
| Image::toTiff() ||
| Image::toJpeg2000() ||
| Image::toHeic() ||
| Image::supports() | 🪲 |

✅ Integrated
🪲 Integrated but has issues
🚧 Partly integrated
❌ Not (yet) integrated

## Contributing

Check out the [documentation](https://github.com/Intervention/image/blob/develop/CONTRIBUTING.md)
## Caveats

```bash
composer test
```
- Due to the technical characteristics of libvips, it is currently not possible
to implement colour quantization via `ImageInterface::reduceColors()` as
intended. However, there is a [pull request in
libvips](https://github.com/libvips/php-vips/issues/256#issuecomment-2575872401)
that enables this feature and may be integrated here in the future.

## Authors

This library was developed by [Oliver Vogel](https://intervention.io) and Thomas Picquet.

Thanks to the community of [contributors](https://github.com/Intervention/image/graphs/contributors) who have helped to improve this project.

## License

Intervention Image Driver Vips is licensed under the [MIT License](LICENSE).

0 comments on commit 4b1d4ee

Please sign in to comment.