diff --git a/README.md b/README.md index b00d1d7f5..28e4d1af6 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,33 @@ ImageProcessor =============== -Imageprocessor is a lightweight library written in C# that allows you to manipulate images on-the-fly using ASP.NET 4.0. +Imageprocessor is a lightweight library written in C# that allows you to manipulate images on-the-fly using .NET 4.0. It's fast, extensible, easy to use, comes bundled with some great features and is fully open source. Core plugins at present include: - - Resize - - Crop - Alpha (Sets opacity) + - Brightness + - Contrast + - Crop - Filter (Image filters including sepia, greyscale, blackwhite, lomograph, polaroid, comic, gotham, hisatch, losatch) - - Watermark (Set a text watermark) + - Flip (Flip the image) - Format (Sets the output format) - - Rotate (Rotate the image) - - Flip (Flip the image) - Quality (The quality to set the output for jpeg files) + - Reset (Resets the image to its original loaded state) + - Resize + - Rotate (Rotate the image through 360ยบ) + - Saturation - Vignette (Adds a vignette effect to images) + - Watermark (Set a text watermark) The library consists of two binaries: **ImageProcessor.dll** and **ImageProcessor.Web.dll**. -**ImageProcessor.dll** contains all the core functionality that allows for image manipulation via the `ImageFactory` class. This has a fluent API which allows you to easily chain methods to deliver the desired output. +ImageProcessor.dll +================== + +**ImageProcessor.dll** contains all the core functionality that allows for image manipulation via the `ImageFactory` class. This has a fluent API which allows you to easily chain methods to deliver the desired output. This library contains no web specific componenets so is suitable for both desktop and web applications. e.g. @@ -38,19 +45,22 @@ e.g. { // Load, resize, set the format and quality and save an image. imageFactory.Load(inStream) - .Resize(size) - .Format(format) - .Quality(quality) - .Save(outStream); + .Resize(size) + .Format(format) + .Quality(quality) + .Save(outStream); } // Do something with the stream. } } -**ImageProcessor.Web.dll** contains a HttpModule which captures internal and external requests automagically processing them based on values captured through querystring parameters. +ImageProcessor.Web.dll +====================== + +**ImageProcessor.Web.dll** contains an ASP.NET HttpModule which captures internal and external requests automagically processing them based on values captured through querystring parameters. -Using the HttpModule requires no code writing at all. Just reference the binaries and add the relevant sections to the web.config +Using the HttpModule requires no code writing at all. Just install the package references the binaries relevant sections in the web.config will be automatically created. Image requests suffixed with querystring parameters will then be processed and **cached to the server - up to 12,960,000 images** allowing for easy and efficient parsing of following requests. @@ -59,9 +69,10 @@ The parsing engine for the HttpModule is incredibly flexible and will **allow yo Installation ============ -Installation is simple. A Nuget package is available [here][1]. +Installation is simple. A Nuget package for the full web version is available [here][1] and the standalone library [here][2]. - [1]: http://nuget.org/packages/ImageProcessor/ + [1]: http://nuget.org/packages/ImageProcessor.Web/ + [2]: http://nuget.org/packages/ImageProcessor/ Alternatively you can download and build the project and reference the binaries. Then copy the example configuration values from the demo project into your `web.config` to enable the processor. @@ -70,25 +81,30 @@ Usage Heres a few examples of the syntax for processing images. -Resize -====== +Alpha Transparency +================== +Imageprocessor can adjust the alpha transparency of png images. Simply pass the desired percentage value (without the '%') to the processor. - your resized image +e.g. -Will resize your image to 200px wide whilst keeping the correct aspect ratio. + 60% alpha image -Remote files can also be requested and cached by prefixing the src with a value set in the web.config +Brightness +================== +Imageprocessor can adjust the brightness of images. Simply pass the desired value (-100 to 100) to the processor. e.g. - your resized image - -Will resize your remote image to 200px wide whilst keeping the correct aspect ratio. - -Changing both width and height requires the following syntax: + 60 brightness + +Contrast +================== +Imageprocessor can adjust the contrast of images. Simply pass the desired value (-100 to 100) to the processor. - your resized image +e.g. + 60 contrast + Crop ==== @@ -98,14 +114,6 @@ e.g. your cropped image -Alpha Transparency -================== -Imageprocessor can adjust the alpha transparency of png images. Simply pass the desired percentage value (without the '%') to the processor. - -e.g. - - 60% alpha image - Filters ======= @@ -114,7 +122,7 @@ Everybody loves adding filter effects to photgraphs so we've baked some popular Current filters include: - blackwhite - - comic + - comic (requires full trust) - lomograph - greyscale - polaroid @@ -138,24 +146,6 @@ e.g. horizontal vertical -Watermark -========= - -Imageprocessor can add watermark text to your images with a wide range of options. Each option can be ommited and can be added in any order. Just ensure that they are pipe "|" separated: - - - text - - size (px) - - font (any installed font) - - opacity (1-100) - - style (bold|italic|regular|strikeout|underline) - - shadow - - position (x,y) - -e.g. - - watermark - -Internally it uses a class named `TextLayer` to add the watermark text. Format ====== @@ -172,7 +162,35 @@ Supported file format just now are: e.g. your image as a gif + +Quality +====== + +Whilst Imageprocessor delivers an excellent quality/filesize ratio it also allows you to change the quality of jpegs on-the-fly. + +e.g. + + your image at quality 30 +Resize +====== + + your resized image + +Will resize your image to 200px wide whilst keeping the correct aspect ratio. + +Remote files can also be requested and cached by prefixing the src with a value set in the web.config + +e.g. + + your resized image + +Will resize your remote image to 200px wide whilst keeping the correct aspect ratio. + +Changing both width and height requires the following syntax: + + your resized image + Rotate ====== @@ -182,17 +200,16 @@ Imageprocessor can rotate your images without clipping. You can also optionally e.g. your image rotated - your image rotated + your image rotated -Quality -====== - -Whilst Imageprocessor delivers an excellent quality/filesize ratio it also allows you to change the quality of jpegs on-the-fly. +Saturation +================== +Imageprocessor can adjust the saturation of images. Simply pass the desired value (-100 to 100) to the processor. e.g. - your image at quality 30 - + 60 saturation + Vignette ====== @@ -201,3 +218,22 @@ Imageprocessor can also add a vignette effect to images. e.g. your image vignetted + +Watermark +========= + +Imageprocessor can add watermark text to your images with a wide range of options. Each option can be ommited and can be added in any order. Just ensure that they are pipe "|" separated: + + - text + - size (px) + - font (any installed font) + - opacity (1-100) + - style (bold|italic|regular|strikeout|underline) + - shadow + - position (x,y) + +e.g. + + watermark + +Internally it uses a class named `TextLayer` to add the watermark text.