Add NetworkImageWithRetry to README.md (flutter#5)

AdamBridges · Sep 18, 2017 · c3d901d · c3d901d
1 parent 9f17b2d
commit c3d901d
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/packages/flutter_image/README.md b/packages/flutter_image/README.md
@@ -1,6 +1,21 @@
 # Image utilities for Flutter
 
-Nothing yet. Stay tuned!
+## NetworkImageWithRetry
+
+Use `NetworkImageWithRetry` instead of `Image.network` to load images from the
+network with a retry mechanism.
+
+Example:
+
+```dart
+var avatar = new Image(
+  image: new NetworkImageWithRetry('http://example.com/avatars/123.jpg'),
+);
+```
+
+The retry mechanism may be customized by supplying a custom `FetchStrategy`
+function. `FetchStrategyBuilder` is a utility class that helps building fetch
+strategy functions.
 
 ## Features and bugs