From b919e8bd8e4a87b0942ce324933ddacee72910f8 Mon Sep 17 00:00:00 2001 From: nfnt Date: Fri, 3 Aug 2012 17:41:21 +0200 Subject: [PATCH] Documentation updated --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e069759..0981320 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,40 @@ Resize Image resizing for the [Go programming language](http://golang.org) that provides a few interpolation methods. +Installation +============ + +```bash +$ go get github.com/nfnt/resize +``` + +It's that easy! + +Usage +===== + +Import package with + +```go +import "github.com/nfnt/resize" +``` + +Resize creates a scaled image with new dimensions (w,h) using the interpolation function interp. + +```go +resize.Resize(w int, h int, img image.Image, interp InterpolationFunction) image.Image +``` + +The provided interpolation functions are + +- NearestNeighbor: Nearest-neighbor interpolation +- Bilinear: Bilinear interpolation +- Bicubic: Bicubic interpolation +- Lanczos3: Convolution with windowed Sinc function, a=3 + License ======= Copyright (c) 2012 Jan Schlicht This software is released unter the ISC license. -The license text is at \ No newline at end of file +The license text is at