From 8aee0d995b6511c4b52187d9b5b7f4da05bbae0b Mon Sep 17 00:00:00 2001 From: jst Date: Thu, 30 Jan 2014 20:03:15 +0100 Subject: [PATCH] Update README.md to mention resize.Thumbnail. --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c25860e..0c58212 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,16 @@ Import package with import "github.com/nfnt/resize" ``` -Resize creates a scaled image with new dimensions (`width`, `height`) using the interpolation function `interp`. -If either `width` or `height` is set to 0, it will be set to an aspect ratio preserving value. +The resize package provides 2 functions: + +* `resize.Resize` creates a scaled image with new dimensions (`width`, `height`) using the interpolation function `interp`. + If either `width` or `height` is set to 0, it will be set to an aspect ratio preserving value. +* `resize.Thumbnail` downscales an image preserving its aspect ratio to the maximum dimensions (`maxWidth`, `maxHeight`). + It will return the original image if original sizes are smaller than the provided dimensions. ```go -resize.Resize(width, height uint, img image.Image, interp resize.InterpolationFunction) image.Image +resize.Resize(width, height uint, img image.Image, interp resize.InterpolationFunction) image.Image +resize.Thumbnail(maxWidth, maxHeight uint, img image.Image, interp resize.InterpolationFunction) image.Image ``` The provided interpolation functions are (from fast to slow execution time)