From cb8b2b3966677cb415a35b80bb0f16c829a176b4 Mon Sep 17 00:00:00 2001 From: Kristina Brainwave Date: Sun, 29 Sep 2013 14:13:15 -0700 Subject: [PATCH] add 'aspect ratio' to the resize documentation --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6400a51..2bdb9de 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,9 @@ function(err, stdout){ ### resize(options, callback(err, stdout, stderr)) -Convenience function for resizing an image, modelled on top of `convert`. +Convenience function for resizing an image, modelled on top of `convert`. + +Because IM preserves the aspect ratio of an image, the area provided in the 'options' argument is not the final size of the image, but the maximum size for the image. The `options` argument have the following default values: