Skip to content

Commit 9dd4717

Browse files
committed
fix documentation errors
1 parent 0016661 commit 9dd4717

File tree

4 files changed

+11
-3
lines changed

4 files changed

+11
-3
lines changed

CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Easy Image
22

3+
## [1.0.1] - 2023-08-21
4+
5+
- Fixed some comparison notes on ImageOptimize to make them more accurate
6+
- Fixed namespace in configuration example
7+
- Added icon for Settings > Plugins page
8+
39
## [1.0.0] - 2023-08-09
410

511
- Added basic picture templating
@@ -11,3 +17,4 @@
1117
- Added tests
1218

1319
[1.0.0]: (https://github.com/acalvino4/craft-easy-image/releases/tag/1.0.0)
20+
[1.0.0]: (https://github.com/acalvino4/craft-easy-image/releases/tag/1.0.1)

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ In `config/easy-image.php` include something like the following (see annotated `
5555
<?php
5656

5757
use acalvino4\easyimage\models\Settings;
58-
use craft\models\TransformSet as TS;
58+
use acalvino4\easyimage\models\TransformSet as TS;
5959

6060
return get_object_vars(new Settings(
6161
transformSets: [

docs/usage-comparison-other-plugins.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Easy Image uses the native transforms under the hood, but if using Easy Image yo
2222

2323
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.
2424

25-
- Doesn't support generating avif (better compression than webp, and no 'color banding')
26-
- You're on your own for generating complex `picture` markup mentioned before
25+
- Configuring variant creation of webp and avif requires setup and configuration beyond ImageMagick (and the avif setup is currently undocumented).
26+
- The function for generating complex `picture` markup is undocumented, and doesn't support art direction or avif variants.
2727
- Configuration must be repeated
2828
- On the subject of pregenerating transforms, this really is a tradeoff, not pure benefit, for a couple reasons:
2929
- 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.

src/icon.svg

+1
Loading

0 commit comments

Comments
 (0)