Permalink
Browse files

Update README

  • Loading branch information...
1 parent 4672768 commit bf28d304bc83ab0f6a5e3f5ba857d09f5d7e41b8 @chrisbanes committed Mar 11, 2013
Showing with 12 additions and 9 deletions.
  1. +12 −9 README.md
View
@@ -13,10 +13,12 @@ A cache which can be set to use multiple layers of caching for Bitmap objects
in an Android app. Instances are created via a `BitmapLruCache.Builder` instance,
which can be used to alter the settings of the resulting cache.
-Instances of this class should ideally be kept globally with the application,
-for example in the `Application` object. You
-should also use the bundled [CacheableImageView](https://github.com/chrisbanes/Android-BitmapCache/blob/master/library/src/uk/co/senab/bitmapcache/CacheableImageView.java) wherever possible, as
-the memory cache has a close relationship with it.
+Instances of this class should ideally be kept globally within your application,
+for example in the `Application` object.
+
+If you wish for the library and recycling feature to work, you **MUST** use the bundled [CacheableImageView](https://github.com/chrisbanes/Android-BitmapCache/blob/master/library/src/uk/co/senab/bitmapcache/CacheableImageView.java) wherever possible.
+
+## Usage
Clients can call `get(String)` to retrieve a cached value from the
given Url. This will check all available caches for the value. There are also
@@ -29,7 +31,7 @@ method, as they allow 1:1 caching to disk of the original content. <br />
`put(String, Bitmap)` and `put(String, Bitmap, boolean)` should
only be used if you can't get access to the original InputStream.
-## Usage
+## Obtaining
The easy way to use the library is by downloading the JAR file, and importing it into your Eclipse project. You can find the latest JAR file from here: [http://bit.ly/android-bitmapcache-jar](http://bit.ly/android-bitmapcache-jar). Just remember that you must include all of the required libraries below too.
If you are a Maven user you can also add this library as a dependency since it
@@ -40,17 +42,18 @@ it distributed to the central repositories. Simply add the following to your
<dependency>
<groupId>com.github.chrisbanes.bitmapcache</groupId>
<artifactId>library</artifactId>
- <version>2.1</version>
+ <version>2.2</version>
</dependency>
```
### Requirements
- * [DiskLruCache](https://github.com/JakeWharton/DiskLruCache). Tested with v1.3.1.
- * [Android v4 Support Library](http://developer.android.com/tools/extras/support-library.html). Preferably the latest available.
+ * [DiskLruCache](https://github.com/JakeWharton/DiskLruCache). Latest available.
+ * [Android v4 Support Library](http://developer.android.com/tools/extras/support-library.html). Latest available.
+
## License
- Copyright 2011, 2012 Chris Banes
+ Copyright 2011, 2012, 2013 Chris Banes
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

0 comments on commit bf28d30

Please sign in to comment.