Skip to content

Commit bba3308

Browse files
committed
Update readme for v2
1 parent a15a44a commit bba3308

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

readme.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@ This plugin supports:
2424

2525
---
2626

27-
**Like this project? [Buy me a coffee!](https://ko-fi.com/liamfiddler)**
27+
**v2 just released! [View the release/upgrade notes](#upgrade-notes)**
28+
29+
---
30+
31+
**Like this project? Buy me a coffee! [PayPal](https://paypal.me/liamfiddler) [ko-fi](https://ko-fi.com/liamfiddler)**
2832

2933
---
3034

@@ -123,7 +127,7 @@ This project welcomes suggestions and Pull Requests!
123127

124128
## Authors
125129

126-
- **Liam Fiddler** - _Initial work_ - [@liamfiddler](https://github.com/liamfiddler)
130+
- **Liam Fiddler** - _Initial work / maintainer_ - [@liamfiddler](https://github.com/liamfiddler)
127131

128132
See also the list of
129133
[contributors](https://github.com/liamfiddler/eleventy-plugin-lazyimages/contributors)
@@ -156,7 +160,7 @@ but you can specify a relative path via the `scriptSrc` configuration option.
156160

157161
### Does my local image path have to match the output path?
158162

159-
**(a.k.a Why do I have "[Error: Input file is missing]" messages in my terminal?)**
163+
**(a.k.a Why do I have "Input file is missing" messages in my terminal?)**
160164

161165
By default this plugin assumes the file referenced in a `src` attribute like
162166
`<img src="/images/dog.jpg" />` exists at `<project root>/images/dog.jpg` or
@@ -176,6 +180,10 @@ eleventyConfig.addPlugin(lazyImagesPlugin, {
176180
});
177181
```
178182

183+
(In the future we hope to make the plugin automatically manage these paths,
184+
once a fix for [eleventy/issues/789](https://github.com/11ty/eleventy/issues/789)
185+
is completed)
186+
179187
### Can I use a different lazy load script?
180188

181189
Yes! By default this plugin uses [LazySizes](https://github.com/aFarkas/lazysizes)
@@ -206,8 +214,21 @@ We've included an
206214
demonstrating this plugin with
207215
[eleventy-plugin-local-images](https://github.com/robb0wen/eleventy-plugin-local-images).
208216

217+
## Upgrade notes
218+
219+
### v2.0.0
220+
221+
The underlying tool used to generate placeholders has switched from JIMP to Sharp.
222+
This allows the plugin to handle a greater variety of image formats, while also increasing in speed.
223+
224+
The API remains largely the same so most sites should not need to adjust their config.
225+
226+
- The default values for `maxPlaceholderWidth` and `maxPlaceholderHeight` have been increased from 12 to 25 - this increases the quality of the LQIP without a significant change in filesize
227+
- `placeholderQuality` has been removed - at the size of the LQIP it didn't make much of a difference to filesize or image quality
228+
- The default value for `preferNativeLazyLoad` is now `false` - most users install this plugin to generate LQIP and the previous default meant the LQIP weren't visible in modern browsers
229+
209230
---
210231

211-
**Like this project? [Buy me a coffee!](https://ko-fi.com/liamfiddler)**
232+
**Like this project? Buy me a coffee! [PayPal](https://paypal.me/liamfiddler) [ko-fi](https://ko-fi.com/liamfiddler)**
212233

213234
---

0 commit comments

Comments
 (0)