Skip to content

Commit

Permalink
fix documentation errors
Browse files Browse the repository at this point in the history
  • Loading branch information
acalvino4 committed Aug 21, 2023
1 parent 0016661 commit 9dd4717
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Easy Image

## [1.0.1] - 2023-08-21

- Fixed some comparison notes on ImageOptimize to make them more accurate
- Fixed namespace in configuration example
- Added icon for Settings > Plugins page

## [1.0.0] - 2023-08-09

- Added basic picture templating
Expand All @@ -11,3 +17,4 @@
- Added tests

[1.0.0]: (https://github.com/acalvino4/craft-easy-image/releases/tag/1.0.0)
[1.0.0]: (https://github.com/acalvino4/craft-easy-image/releases/tag/1.0.1)
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ In `config/easy-image.php` include something like the following (see annotated `
<?php

use acalvino4\easyimage\models\Settings;
use craft\models\TransformSet as TS;
use acalvino4\easyimage\models\TransformSet as TS;

return get_object_vars(new Settings(
transformSets: [
Expand Down
4 changes: 2 additions & 2 deletions docs/usage-comparison-other-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Easy Image uses the native transforms under the hood, but if using Easy Image yo

nystudio107's image optimization plugin does a lot, including pregenerating transforms, generating placeholders, providing a control panel UI for defining transforms sets. Again though, there are some drawbacks and things it misses.

- Doesn't support generating avif (better compression than webp, and no 'color banding')
- You're on your own for generating complex `picture` markup mentioned before
- Configuring variant creation of webp and avif requires setup and configuration beyond ImageMagick (and the avif setup is currently undocumented).
- The function for generating complex `picture` markup is undocumented, and doesn't support art direction or avif variants.
- Configuration must be repeated
- On the subject of pregenerating transforms, this really is a tradeoff, not pure benefit, for a couple reasons:
- Content authors need to be concious of uploading images to the appropriate volume based on what transforms need to be done on the image, rather than organizing assets based on a logical content hierarchy. This breaks the abstration of content authors not needing to worry about implementation details.
Expand Down
1 change: 1 addition & 0 deletions src/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9dd4717

Please sign in to comment.