READMEのアップデート

Author: pixel-ink

PIImageCache/PIImageCacheTests/PIImageCacheTests.swift

@@ -254,4 +254,24 @@ class PIImageCacheTests: XCTestCase {
     }
   }
 
+  func testREADME() {
+    let url = NSURL(string: "http://place-hold.it/200x200")!
+    var image = url.getImageWithCache()
+    XCTAssert(image!.size.width == 200 && image!.size.height == 200 , "Pass")
+    let imgView = UIImageView()
+    imgView.imageOfURL(url) {
+      isOK in
+      XCTAssert(isOK , "Pass")
+    }
+    var cache = PIImageCache()
+    image = cache.get(url)!
+    XCTAssert(image!.size.width == 200 && image!.size.height == 200 , "Pass")
+    var config = PIImageCache.Config()
+    config.maxCount = 5
+    config.maxByteSize = 100
+    cache.setConfig(config)
+    image = cache.get(url)!
+    XCTAssert(image!.size.width == 200 && image!.size.height == 200 , "Pass")
+  }
+  
 }

README.md

@@ -7,25 +7,57 @@
 
 ## NSURL -> UIImage with cache (swift)
 
-![](https://cocoapod-badges.herokuapp.com/l/PIRipple/badge.png)
-![](https://cocoapod-badges.herokuapp.com/p/PIRipple/badge.png)
+![](https://cocoapod-badges.herokuapp.com/l/PIImageCache/badge.png)
+![](https://cocoapod-badges.herokuapp.com/v/PIImageCache/badge.png)
+![](https://cocoapod-badges.herokuapp.com/p/PIImageCache/badge.png)
 
 ---
 
+
 # install
 
 - manually
   - add PIImageCache.swift into your project
+- cocoapods
+  - add " pod 'PIImageCache', '0.1.1' " into your Podfile
+  - add " import PIImageCache " into your code
+
+# basic usage
 
-# usage
+## NSURL extension
 
-- create cache instance
-- get image by NSURL extension
+```NSURL.swift
+let url = NSURL(string: "http://place-hold.it/200x200")!
+let image = url.getImageWithCache()
+```
 
-# example
+## UIImageView extension
 
+```UIImageView.swift
+let url = NSURL(string: "http://place-hold.it/200x200")!
+let imgView = UIImageView()
+imgView.imageOfURL(url)
 ```
-  let url = NSURL(string: "http://place-hold.it/200x200")!
-  let cache = PIImageCache()
-  url.getImageWithCache(cache)
+
+## for background
+
+```PIImageCache.swift
+let url = NSURL(string: "http://place-hold.it/200x200")!
+let cache = PIImageCache.shared
+image = cache.get(url)!
 ```
+
+# advanced usage
+
+## configurable
+
+```Config.swift
+let cache = PIImageCache.shared
+var config = PIImageCache.Config()
+config.maxCount = 5
+config.maxByteSize = 100
+cache.setConfig(config)
+
+let url = NSURL(string: "http://place-hold.it/200x200")!
+let image = cache.get(url)!
+```