Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
That was a really old history message :-)
  • Loading branch information
molinch committed Dec 29, 2015
1 parent 2d9c2ff commit 0b158ce
Showing 1 changed file with 32 additions and 35 deletions.
67 changes: 32 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,54 @@
# FFImageLoading - Fast & Furious Image Loading

Library to load images quickly & easily on Xamarin.iOS, Xamarin.Android, Xamarin.Forms and Windows (WinRT, UWP).

*Authors: Fabien Molinet, Daniel Luberda*

| Xamarin iOS / Android | Xamarin Forms | Windows RT / UWP | Transformations |
|:----:|:----:|:----:|:----:|
| [Nuget](https://www.nuget.org/packages/Xamarin.FFImageLoading/) | [Nuget](https://www.nuget.org/packages/Xamarin.FFImageLoading.Forms/) | [Nuget](https://www.nuget.org/packages/FFImageLoading.Windows/) | [Nuget](https://www.nuget.org/packages/Xamarin.FFImageLoading.Transformations/) |
Library to load images quickly & easily on Xamarin.iOS, Xamarin.Android, Xamarin.Forms and Windows (WinRT, UWP).

*Authors: Fabien Molinet, Daniel Luberda*

| Xamarin iOS / Android | Xamarin Forms | Windows RT / UWP | Transformations |
|:----:|:----:|:----:|:----:|
| [Nuget](https://www.nuget.org/packages/Xamarin.FFImageLoading/) | [Nuget](https://www.nuget.org/packages/Xamarin.FFImageLoading.Forms/) | [Nuget](https://www.nuget.org/packages/FFImageLoading.Windows/) | [Nuget](https://www.nuget.org/packages/Xamarin.FFImageLoading.Transformations/) |

<a href="https://raw.githubusercontent.com/molinch/FFImageLoading/master/samples/Screenshots/ffimageloading_large.png"><img src="https://raw.githubusercontent.com/molinch/FFImageLoading/master/samples/Screenshots/ffimageloading.png"/></a>

**Xamarin.Forms Demo:** [link](https://github.com/molinch/FFImageLoading/tree/master/samples/ImageLoading.Forms.Sample), **Android Demo:** [link](https://github.com/molinch/FFImageLoading/tree/master/samples/ImageLoading.Sample), **Windows Demo:** [link](https://github.com/molinch/FFImageLoading/tree/master/samples/Simple.WinPhone.Sample)
**Xamarin.Forms Demo:** [link](https://github.com/molinch/FFImageLoading/tree/master/samples/ImageLoading.Forms.Sample), **Android Demo:** [link](https://github.com/molinch/FFImageLoading/tree/master/samples/ImageLoading.Sample), **Windows Demo:** [link](https://github.com/molinch/FFImageLoading/tree/master/samples/Simple.WinPhone.Sample)


## Features

- Xamarin.iOS (min iOS 7), Xamarin.Android (min Android 4), Xamarin.Forms and Windows (WinRT, UWP) support
- Configurable disk and memory caching
- Configurable disk and memory caching
- Multiple image views using the same image source (url, path, resource) will use only one bitmap which is cached in memory (less memory usage)
- Deduplication of similar download/load requests. *(If 100 similar requests arrive at same time then one real loading will be performed while 99 others will wait).*
- Error and loading placeholders support
- Images can be automatically downsampled to specified size (less memory usage)
- Images can be automatically downsampled to specified size (less memory usage)
- Fluent API which is inspired by Picasso naming
- WebP support
- Image loading Fade-In animations support
- Can retry image downloads (RetryCount, RetryDelay)
- On Android transparency is disabled by default (configurable). Saves 50% of memory
- Transformations support
- BlurredTransformation
- CircleTransformation, RoundedTransformation, CornersTransformation, CropTransformation
- ColorSpaceTransformation, GrayscaleTransformation, SepiaTransformation
- BlurredTransformation
- CircleTransformation, RoundedTransformation, CornersTransformation, CropTransformation
- ColorSpaceTransformation, GrayscaleTransformation, SepiaTransformation
- FlipTransformation, RotateTransformation
- Supports custom transformations (native platform `ITransformation` implementations)

### History
We developed this library while working on an app that displays tons of pictures, very quickly, and that are mostly not reused. We tried to use Picasso with C# bindings, we got good performances but many memory issues too. We then chose to go C# all the way: we believed it would be easier for us to debug and maintain. It is the case.

## Documentation

- **General**
- [Fluent Syntax](https://github.com/molinch/FFImageLoading/wiki/Fluent-Syntax)

- **Android, iOS, Windows Phone**
- [Common API](https://github.com/molinch/FFImageLoading/wiki/API)
- [Android Specificities](https://github.com/molinch/FFImageLoading/wiki/Android-API)
- [iOS Specificities](https://github.com/molinch/FFImageLoading/wiki/iOS-API)
- [Windows Specificities](https://github.com/molinch/FFImageLoading/wiki/Windows-API)
- [Advanced usage](https://github.com/molinch/FFImageLoading/wiki/Advanced-Usage)

- **Xamarin.Forms**
- [Xamarin.Forms API](https://github.com/molinch/FFImageLoading/wiki/Xamarin.Forms-API)
- [Xamarin.Forms Advanced](https://github.com/molinch/FFImageLoading/wiki/Xamarin.Forms-Advanced)

- **Transformations**
- [Transformations Guide](https://github.com/molinch/FFImageLoading/wiki/Transformations-Guide)
- [Custom Transformations Guide](https://github.com/molinch/FFImageLoading/wiki/Custom-Transformations-Guide)
## Documentation

- **General**
- [Fluent Syntax](https://github.com/molinch/FFImageLoading/wiki/Fluent-Syntax)

- **Android, iOS, Windows Phone**
- [Common API](https://github.com/molinch/FFImageLoading/wiki/API)
- [Android Specificities](https://github.com/molinch/FFImageLoading/wiki/Android-API)
- [iOS Specificities](https://github.com/molinch/FFImageLoading/wiki/iOS-API)
- [Windows Specificities](https://github.com/molinch/FFImageLoading/wiki/Windows-API)
- [Advanced usage](https://github.com/molinch/FFImageLoading/wiki/Advanced-Usage)

- **Xamarin.Forms**
- [Xamarin.Forms API](https://github.com/molinch/FFImageLoading/wiki/Xamarin.Forms-API)
- [Xamarin.Forms Advanced](https://github.com/molinch/FFImageLoading/wiki/Xamarin.Forms-Advanced)

- **Transformations**
- [Transformations Guide](https://github.com/molinch/FFImageLoading/wiki/Transformations-Guide)
- [Custom Transformations Guide](https://github.com/molinch/FFImageLoading/wiki/Custom-Transformations-Guide)

0 comments on commit 0b158ce

Please sign in to comment.