Update the readme

Author: dreampiggy

Example/Podfile.lock

@@ -31,7 +31,7 @@ CHECKOUT OPTIONS:
 
 SPEC CHECKSUMS:
   SDWebImage: 55c787b164fabe07f2a4d5307f6e1be7960fb9be
-  SDWebImageYYPlugin: 3941a3f01e054bf6c6c64b5e14fb3ec1822fa994
+  SDWebImageYYPlugin: 4a756eec055647c989fe9d54f9535780bc0e0465
   YYCache: 8105b6638f5e849296c71f331ff83891a4942952
   YYImage: 1e1b62a9997399593e4b9c4ecfbbabbf1d3f3b54
 

README.md

@@ -5,12 +5,53 @@
 [![License](https://img.shields.io/cocoapods/l/SDWebImageYYPlugin.svg?style=flat)](https://cocoapods.org/pods/SDWebImageYYPlugin)
 [![Platform](https://img.shields.io/cocoapods/p/SDWebImageYYPlugin.svg?style=flat)](https://cocoapods.org/pods/SDWebImageYYPlugin)
 
-## Example
 
-To run the example project, clone the repo, and run `pod install` from the Example directory first.
+## What's for
+SDWebImageYYPlugin is a plugin for [SDWebImage](https://github.com/rs/SDWebImage/) framework, which provide the image loading support for [YYImage](https://github.com/ibireme/YYImage) (including YYImage's decoding system and `YYAnimatedImageView`) and [YYCache](https://github.com/ibireme/YYCache) cache system.
+
+By using SDWebImageYYPlugin, you can use all you familiar SDWebImage's loading method, on the `YYAnimatedImageView`.
+
+And you can also use `YYCache` instead of `SDImageCache` for image cache system, which may better memory cache performance (By taking advanced of LRU algorithm), and disk cache performance (By taking advanced of sqlite blob storage)
+
+## Usage
+To load a network image, simply call the View Category method like UIImageView.
+
++ Objective-C
+
+```objectivec
+YYAnimatedImageView *imageView;
+[imageView sd_setImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/to/image.gif"]];
+```
+
++ Swift
+
+```swift
+let imageView: YYAnimatedImageView
+imageView.sd_setImage(with: URL(string: "http://www.domain.com/path/to/image.gif"))
+```
+
+To enable `YYCache` instead of `SDImageCache`, you can bind the cache for shared manager, or create a custom manager instead.
+
+You can also use `YYMemoryCache` or `YYDiskcache` to customize memory cache / disk cache only. See [Custom Cache](https://github.com/rs/SDWebImage/wiki/Advanced-Usage#custom-cache-50) wiki in SDWebImage.
+
++ Objective-C
+
+```objectivec
+// Assign to shared manager
+SDWebImageManger.defaultCache = [YYCache sharedCache];
+```
+
++ Swift
+
+```swift
+SDWebImageManger.defaultCache = YYCache.shared
+```
 
 ## Requirements
 
++ iOS 8+
++ Xcode 9+
+
 ## Installation
 
 SDWebImageYYPlugin is available through [CocoaPods](https://cocoapods.org). To install
@@ -20,10 +61,19 @@ it, simply add the following line to your Podfile:
 pod 'SDWebImageYYPlugin'
 ```
 
+SDWebImageYYPlugin contains two subspecs, `YYCache` and `YYImage`. You can choose to enable only some of them. By default will contains all subspecs.
+
+```ruby
+pod 'SDWebImageYYPlugin/YYImage'
+pod 'SDWebImageYYPlugin/YYCache'
+```
+
 ## Author
 
 DreamPiggy, [email protected]
 
 ## License
 
 SDWebImageYYPlugin is available under the MIT license. See the LICENSE file for more info.
+
+

SDWebImageYYPlugin.podspec

@@ -37,11 +37,11 @@ TODO: Add long description of the pod here.
 
   s.subspec 'YYCache' do |ss|
     ss.dependency 'YYCache'
-    ss.source_files = 'SDWebImageYYPlugin/Classes/YYCache/**/*'
+    ss.source_files = 'SDWebImageYYPlugin/Classes/YYCache/**/*', 'SDWebImageYYPlugin/Module/SDWebImageYYPlugin.h'
   end
 
   s.subspec 'YYImage' do |ss|
     ss.dependency 'YYImage/Core'
-    ss.source_files = 'SDWebImageYYPlugin/Classes/YYImage/**/*'
+    ss.source_files = 'SDWebImageYYPlugin/Classes/YYImage/**/*', 'SDWebImageYYPlugin/Module/SDWebImageYYPlugin.h'
   end
 end