From 98554e919cf9ec854c414ae9da4d874caf43ae03 Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Fri, 22 Aug 2014 16:57:05 +0100 Subject: [PATCH] Small doc improvements ahead of v0.6.0 --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 665733a3..36e2c518 100755 --- a/README.md +++ b/README.md @@ -172,10 +172,9 @@ sharp('input.gif').resize(200, 300).embedBlack().webp().toBuffer(function(err, o ``` ```javascript -sharp(inputBuffer).resize(200, 200).max().jpeg().toBuffer().then(function(outputBuffer, info) { +sharp(inputBuffer).resize(200, 200).max().jpeg().toBuffer().then(function(outputBuffer) { // outputBuffer contains JPEG image data no wider than 200 pixels and no higher // than 200 pixels regardless of the inputBuffer image dimensions - // info.width and info.height contain the final pixel dimensions of the resized image }); ``` @@ -353,8 +352,8 @@ sharp.cache(50, 200); // { current: 49, high: 99, memory: 50, items: 200} Provides access to internal task counters. -* `queue` is the number of tasks queuing for _libuv_ to provide a thread from its pool -* `process` is the number of tasks being processed +* `queue` is the number of tasks this module has queued waiting for _libuv_ to provide a worker thread from its pool. +* `process` is the number of resize tasks currently being processed. ```javascript var counters = sharp.counters(); // { queue: 2, process: 4 }