From 72354d55a829b621ab8f0096afd7473bcf4098df Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Sat, 13 Aug 2016 17:24:06 +0100 Subject: [PATCH] Doc and changelog updates #519 #540 --- docs/api.md | 6 +++--- docs/changelog.md | 8 ++++++++ 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/api.md b/docs/api.md index b446bc1b..c3afa78e 100644 --- a/docs/api.md +++ b/docs/api.md @@ -453,12 +453,12 @@ Enhance output image contrast by stretching its luminance to cover the full dyna #### overlayWith(image, [options]) -Overlay (composite) a image containing an alpha channel over the processed (resized, extracted etc.) image. +Overlay (composite) a image over the processed (resized, extracted etc.) image. `image` is one of the following, and must be the same size or smaller than the processed image: -* Buffer containing PNG, WebP, GIF, SVG, raw pixel image data, or -* String containing the path to an image file, with most major transparency formats supported. +* Buffer containing image data, or +* String containing the path to an image file `options`, if present, is an Object with the following optional attributes: diff --git a/docs/changelog.md b/docs/changelog.md index 00878e57..44537573 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -25,10 +25,18 @@ Requires libvips v8.3.3 [#516](https://github.com/lovell/sharp/pull/516) [@mhirsch](https://github.com/mhirsch) +* Prevent bandbool creating a single channel sRGB image. + [#519](https://github.com/lovell/sharp/pull/519) + [@mhirsch](https://github.com/mhirsch) + * Ensure ICC profiles are removed from PNG output unless withMetadata used. [#521](https://github.com/lovell/sharp/issues/521) [@ChrisPinewood](https://github.com/ChrisPinewood) +* Add alpha channels, if missing, to overlayWith images. + [#540](https://github.com/lovell/sharp/pull/540) + [@cmtt](https://github.com/cmtt) + * Remove deprecated interpolateWith method - use resize(w, h, { interpolator: ... }) [#310](https://github.com/lovell/sharp/issues/310)