Permalink
Browse files

Update README.md

  • Loading branch information...
1 parent 87d2d45 commit 4bafc81733bf7e81fee66fdabd39a00fb03da9cf @koush committed Apr 2, 2012
Showing with 23 additions and 3 deletions.
  1. +23 −3 README.md
View
26 README.md
@@ -1,31 +1,51 @@
+## UrlImageViewHelper
UrlImageViewHelper will fill an ImageView with an image that is found at a URL.
+### Sample Project
+
The sample will do a Google Image Search and load/show the results asynchronously.
+
+### Usage
+
UrlImageViewHelper will automatically download, save, and cache all the image urls
the BitmapDrawables. Duplicate urls will not be loaded into memory twice.
Bitmap memory is managed by using a weak reference hash table, so as soon as the
image is no longer used by you, it will be garbage collected automatically.
Usage is simple:
+```java
UrlImageViewHelper.setUrlDrawable(imageView, "http://example.com/image.png");
+```
+
Want a placeholder image while it is being downloaded?
+```java
UrlImageViewHelper.setUrlDrawable(imageView, "http://example.com/image.png", R.drawable.placeholder);
+```
+
Don't want to use a placeholder resource, but a drawable instead?
+```java
UrlImageViewHelper.setUrlDrawable(imageView, "http://example.com/image.png", drawable);
+```
+
What if you want to preload images for snazzy fast loading?
+```java
UrlImageViewHelper.loadUrlDrawable(context, "http://example.com/image.png");
+```
-What if you only want to cache the images for a minute?
-UrlImageViewHelper.setUrlDrawable(imageView, "http://example.com/image.png", /* This an optional interstitial argument */ null, 60000);
+What if you only want to cache the images for a minute?
+```java
+// Note that the 3rd argument "null" is an optional interstitial
+// placeholder image.
+UrlImageViewHelper.setUrlDrawable(imageView, "http://example.com/image.png", null, 60000);
+```
-TODO: An http connection manager for connection reuse might be handy.

0 comments on commit 4bafc81

Please sign in to comment.