Explorar el Código

Documentation updated

nfnt hace 13 años
padre
commit
b919e8bd8e
Se han modificado 1 ficheros con 32 adiciones y 1 borrados
  1. 32 1
      README.md

+ 32 - 1
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 <janschlicht@gmail.com>
 This software is released unter the ISC license.
-The license text is at <http://www.isc.org/software/license>
+The license text is at <http://www.isc.org/software/license>