Skip to content

Loading…

add 'aspect ratio' to the resize documentation #109

Open
wants to merge 1 commit into from

1 participant

@kbrainwave

Added information about IM's preservation of 'aspect ratio' when resizing images.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Sep 29, 2013
  1. @kbrainwave
This page is out of date. Refresh to see the latest.
Showing with 3 additions and 1 deletion.
  1. +3 −1 README.md
View
4 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:
Something went wrong with that request. Please try again.