From 8bad01d8feeb8d66fb362829ff1bc615cceb6483 Mon Sep 17 00:00:00 2001 From: Scott Williams Date: Wed, 4 Jan 2017 07:12:32 +0000 Subject: [PATCH] added projected to readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 24145f7f9..702a363a8 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,27 @@ At present the code is pre-release but when ready it will be available on [Nuget We already have a [MyGet package repository](https://www.myget.org/gallery/imagesharp) - for bleeding-edge / development NuGet releases. +### Packages + +The **ImageSharp** library is made up of multiple packages, to make **ImageShape** so anything useful you will want to make sure you include at least 1 Format as a dependency otherwise you will note be able to save/load any images. + +Packages include; +- **ImageSharp** + Contains the Image classes, Colors, Primitives, Bootstrapper, IImageFormat interface, and other core functionality. +- **ImageSharp.Formats.Jpeg** + The jpeg decoder/encoder (Auto registered) +- **ImageSharp.Formats.Png** + The png decoder/encoder (Auto registered) +- **ImageSharp.Formats.Gif** + The gif decoder/encoder (Auto registered) +- **ImageSharp.Formats.Bmp** + The bmp decoder/encoder (Auto registered) +- **ImageSharp.Processing** + Contains methods like Resize, Crop, Skew, Rotate - Anything that alters the dimensions of the image. + Contains methods like Gaussian Blur, Pixelate, Edge Detection - Anything that maintains the original image dimensions. +- **ImageSharp.Drawing** + Brushes and various drawing algorithms. + ### Manual build If you prefer, you can compile ImageSharp yourself (please do and help!), you'll need: