From dcb7a4a22dca51fb5a6fe95cc3ea3162608783fd Mon Sep 17 00:00:00 2001 From: Hage Yaapa Date: Sun, 3 May 2015 19:15:57 +0530 Subject: [PATCH] docs --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5bbd5c6..29571c2 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ var easyimg = require('easyimage'); EasyImage offers these promise methods: ``` -easyimg.info() - to retrieve information about an image. Will return an object with the following properties - `type`, `depth`, `width`, `height`, `size`, `density`, `name`, and `path`. +easyimg.info() - to retrieve information about an image. Will return an object with the following properties - type, depth, width, height, size, density, name, and path. easyimg.convert() - to convert an image from one format to another. easyimg.resize() - to resize an image. easyimg.crop() - to crop an image. @@ -54,9 +54,9 @@ x - x offset for cropping, defaults to 0. y - y offset for cropping, defaults to 0. quality - quality of processed image, 1 to 100. gravity - crop position [NorthWest | North | NorthEast | West | Center | East | SouthWest | South | SouthEast], defaults to Center. -fill - fill area flag, image is resized to completely fill the target crop dimensions, defaults to `false`. +fill - fill area flag, image is resized to completely fill the target crop dimensions, defaults to false. background - background color, defaults to "white". If specified, automatically flattens the image. -flatten - if present, the image will be flattened (flattening removes alpha channel). +flatten - if present, the image will be flattened (flattening removes alpha channel). Defaults to false. ``` ## Examples @@ -90,7 +90,7 @@ easyimg.rescrop({ } ); ``` -For more examples check out [test.js](https://github.com/hacksparrow/node-easyimage/blob/master/test.js). +For more examples check out [test/test.js](https://github.com/hacksparrow/node-easyimage/blob/master/test.js). ## License (MIT)