pica 6.1.0 → 7.1.1

package/README.md

@@ -1,7 +1,7 @@
 pica - high quality image resize in browser
 ===========================================
 
-[![Build Status](https://travis-ci.org/nodeca/pica.svg?branch=master)](https://travis-ci.org/nodeca/pica)
+[![CI](https://github.com/nodeca/pica/actions/workflows/ci.yml/badge.svg)](https://github.com/nodeca/pica/actions/workflows/ci.yml)
 [![NPM version](https://img.shields.io/npm/v/pica.svg)](https://www.npmjs.org/package/pica)
 
 > Resize images in browser without pixelation and reasonably fast.
@@ -20,7 +20,16 @@ With pica you can:
 
 **Note. If you need File/Blob resize (from form's file input), consider use
 [image-blob-reduce](https://github.com/nodeca/image-blob-reduce).** It has
-additional machinery to process orientation, keep EXIF metadata and so on. 
+additional machinery to process orientation, keep EXIF metadata and so on.
+
+
+Migration from pica v6 to pica v7
+---------------------------------
+
+Multiply `unsharpAmount` by 2, divide `unsharpThreshold` by 2, example:
+
+ - `pica@6`: `pica.resize(a, b, { unsharpAmount: 80, unsharpThreshold: 2 })`
+ - `pica@7`: `pica.resize(a, b, { unsharpAmount: 160, unsharpThreshold: 1 })`
 
 
 Prior to use
@@ -32,7 +41,7 @@ Here is a short list of problems you can face:
   - Due to JS security restrictions, you can process images
     from the same domain or local files only. If you load images from
     remote domain use proper `Access-Control-Allow-Origin` header.
-  - iOS has a memory limits for canvas elements, that may cause 
+  - iOS has a memory limits for canvas elements, that may cause
     problems in some cases, [more details](https://github.com/nodeca/pica/wiki/iOS-Memory-Limit).
   - If your source data is jpeg image, it can be rotated. Consider use
     [image-blob-reduce](https://github.com/nodeca/image-blob-reduce).
@@ -67,9 +76,9 @@ const pica = require('pica')();
 
 // Resize from Canvas/Image to another Canvas
 pica.resize(from, to, {
-  unsharpAmount: 80,
+  unsharpAmount: 160,
   unsharpRadius: 0.6,
-  unsharpThreshold: 2
+  unsharpThreshold: 1
 })
 .then(result => console.log('resize done!'));
 
@@ -101,8 +110,8 @@ Create resizer instance with given config (optional):
    Default returns a [\<canvas\> element](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API),
    but this function could return an [OffscreenCanvas](https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas)
    instead (to run pica in a Service Worker). Function signature: createCanvas(width: number, height: number): Canvas
-     
-   
+
+
 __Important!__ Latest browsers may support resize via [createImageBitmap](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/createImageBitmap).
 This feature is supported (`cib`) but disabled by default and not recommended
 for use. So:
@@ -125,7 +134,7 @@ taken from source and destination objects.
   - __quality__ - 0..3. Default = `3` (lanczos, win=3).
   - __alpha__ - use alpha channel. Default = `false`.
   - __unsharpAmount__ - >=0, in percents. Default = `0` (off). Usually
-    between 50 to 100 is good.
+    between 100 to 200 is good.
   - __unsharpRadius__ - 0.5..2.0. By default it's not set. Radius of Gaussian
     blur. If it is less than 0.5, Unsharp Mask is off. Big values are clamped
     to 2.0.
@@ -198,10 +207,10 @@ a bit. Pica has built-in "unsharp mask" filter (off by default).
 Set `unsharpAmount` to positive number to activate the filter.
 
 Filter's parameters are similar to ones from Photoshop.
-We recommend to start with `unsharpAmount = 80`,
-`unsharpRadius = 0.6` and `unsharpThreshold = 2`.
+We recommend to start with `unsharpAmount = 160`,
+`unsharpRadius = 0.6` and `unsharpThreshold = 1`.
 There is [a correspondence between UnsharpMask parameters
-in popular graphics software](https://github.com/nodeca/pica/wiki#editing-unsharp-mask-params-relations-in-pupular-softare).
+in popular graphics software](https://github.com/nodeca/pica/wiki/Unsharp-mask-params-in-popular-softare).
 
 
 Browser support