update readme

README.md

@@ -1,4 +1,4 @@
-YYImage
+YYImage <a href="#中文介绍">中文介绍</a>
 ==============
 [![License MIT](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://raw.githubusercontent.com/ibireme/YYImage/master/LICENSE)&nbsp;
 [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)&nbsp;
@@ -117,6 +117,13 @@ Usage
 	[webpEncoder addImage:image2 duration:0.2];
 	NSData webpData = [webpEncoder encode];
 
+###Image type detection
+
+	// Get image type from image data
+	YYImageType type = YYImageDetectType(data); 
+	if (type == YYImageTypePNG) ...
+	
+	
 Installation
 ==============
 
@@ -160,3 +167,174 @@ This library supports iOS 6.0 and later.
 License
 ==============
 YYImage is provided under the MIT license. See LICENSE file for details.
+
+
+<br/><br/>
+---
+中文介绍
+==============
+YYImage: 功能强大的 iOS 图像框架。
+
+
+特性
+==============
+- 支持以下类型动画图像的播放/编码/解码:<br/>
+  &nbsp;&nbsp;&nbsp;&nbsp;WebP, APNG, GIF。
+- 支持以下类型静态图像的显示/编码/解码:<br>
+  &nbsp;&nbsp;&nbsp;&nbsp;WebP, PNG, GIF, JPEG, JP2, TIFF, BMP, ICO, ICNS。
+- 支持以下类型图片的渐进式/逐行扫描/隔行扫描解码:<br/>
+  &nbsp;&nbsp;&nbsp;&nbsp;PNG, GIF, JPEG, BMP。
+- 支持多张图片构成的帧动画播放，支持单张图片的 sprite sheet 动画。
+- 完全兼容 UIImage 和 UIImageView，使用方便。
+- 保留可扩展的接口，以支持自定义动画。
+- 高效的动态内存缓存管理，以保证高性能低内存的动画播放。
+- 利用 ImageIO 与 Accelerate 实现高性能的图片编码解码。
+
+
+用法
+==============
+
+###显示动画类型的图片
+	
+	// 文件: ani@3x.gif
+	UIImage *image = [YYImage imageNamed:@"ani.gif"];
+	UIImageView *imageView = [[YYAnimatedImageView alloc] initWithImage:image];
+	[self.view addSubView:imageView];
+
+
+###播放帧动画
+	
+	// 文件: frame1.png, frame2.png, frame3.png
+	NSArray *paths = @[@"/ani/frame1.png", @"/ani/frame2.png", @"/ani/frame3.png"];
+	NSArray *times = @[@0.1, @0.2, @0.1];
+	UIImage *image = [YYFrameImage alloc] initWithImagePaths:paths frameDurations:times repeats:YES];
+	UIImageView *imageView = [YYAnimatedImageView alloc] initWithImage:image];
+	[self.view addSubView:imageView];
+
+###播放 sprite sheet 动画
+
+	// 8 * 12 sprites in a single sheet image
+	UIImage *spriteSheet = [UIImage imageNamed:@"sprite-sheet"];
+	NSMutableArray *contentRects = [NSMutableArray new];
+	NSMutableArray *durations = [NSMutableArray new];
+	for (int j = 0; j < 12; j++) {
+	   for (int i = 0; i < 8; i++) {
+	       CGRect rect;
+	       rect.size = CGSizeMake(img.size.width / 8, img.size.height / 12);
+	       rect.origin.x = img.size.width / 8 * i;
+	       rect.origin.y = img.size.height / 12 * j;
+	       [contentRects addObject:[NSValue valueWithCGRect:rect]];
+	       [durations addObject:@(1 / 60.0)];
+	   }
+	}
+	YYSpriteSheetImage *sprite;
+	sprite = [[YYSpriteSheetImage alloc] initWithSpriteSheetImage:img
+	                                                contentRects:contentRects
+	                                              frameDurations:durations
+	                                                   loopCount:0];
+	YYAnimatedImageView *imageView = [YYAnimatedImageView new];
+	imageView.size = CGSizeMake(img.size.width / 8, img.size.height / 12);
+	imageView.image = sprite;
+	[self.view addSubView:imageView];
+
+###动画播放控制
+	
+	YYAnimatedImageView *imageView = ...;
+	// 暂停:
+	[imageView stopAnimating];
+	// 播放:
+	[imageView startAnimating];
+	// 设置播放进度:
+	imageView.currentAnimatedImageIndex = 12;
+	// 获取播放状态:
+	image.currentIsPlayingAnimation;
+	//上面两个属性都支持 KVO。
+	
+###图片解码
+		
+	// 解码单帧图片:
+	NSData *data = [NSData dataWithContentOfFile:@"/tmp/image.webp"];
+	YYImageDecoder *decoder = [YYImageDecoder decoderWithData:data scale:2.0];
+	UIImage image = [decoder frameAtIndex:0 decodeForDisplay:YES].image;
+	
+	// 渐进式图片解码 (可用于图片下载显示):
+	NSMutableData *data = [NSMutableData new];
+	YYImageDecoder *decoder = [[YYImageDecoder alloc] initWithScale:2.0];
+	while(newDataArrived) {
+	   [data appendData:newData];
+	   [decoder updateData:data final:NO];
+	   if (decoder.frameCount > 0) {
+	       UIImage image = [decoder frameAtIndex:0 decodeForDisplay:YES].image;
+	       // progressive display...
+	   }
+	}
+	[decoder updateData:data final:YES];
+	UIImage image = [decoder frameAtIndex:0 decodeForDisplay:YES].image;
+	// final display...
+
+###图片编码
+	
+	// 编码静态图 (支持各种常见图片格式):
+	YYImageEncoder *jpegEncoder = [[YYImageEncoder alloc] initWithType:YYImageTypeJPEG];
+	jpegEncoder.quality = 0.9;
+	[jpegEncoder addImage:image duration:0];
+	NSData jpegData = [jpegEncoder encode];
+	 
+	// 编码动态图 (支持 GIF/APNG/WebP):
+	YYImageEncoder *webpEncoder = [[YYImageEncoder alloc] initWithType:YYImageTypeWebP];
+	webpEncoder.loopCount = 5;
+	[webpEncoder addImage:image0 duration:0.1];
+	[webpEncoder addImage:image1 duration:0.15];
+	[webpEncoder addImage:image2 duration:0.2];
+	NSData webpData = [webpEncoder encode];
+	
+###图片类型探测
+
+	// 获取图片类型
+	YYImageType type = YYImageDetectType(data); 
+	if (type == YYImageTypePNG) ...
+	
+
+安装
+==============
+
+### Cocoapods
+
+1. 将 cocoapods 更新至最新版本.
+1. 在 Podfile 中添加 `pod "YYImage"`。
+2. 执行 `pod install` 或 `pod update`。
+3. 导入 \<YYImage/YYImage.h\>。
+
+
+### Carthage
+
+1. 在 Cartfile 中添加 `github "ibireme/YYImage"`。
+2. 执行 `carthage update --platform ios` 并将生成的 framework 添加到你的工程。
+3. 导入 \<YYImage/YYImage.h\>。
+4. 注意: carthage framework 并没有包含 webp 组件。如果你需要支持 webp，可以用 Cocoapods 安装，或者手动安装。
+
+### 手动安装
+
+1. 下载 YYImage 文件夹内的所有内容。
+2. 将 YYModel 内的源文件添加(拖放)到你的工程。
+3. 链接以下 frameworks:
+	* UIKit.framework
+	* CoreFoundation.framework
+	* QuartzCore.framework
+	* AssetsLibrary.framework
+	* ImageIO.framework
+	* Accelerate.framework
+	* MobileCoreServices.framework
+	* libz
+4. 如果你需要支持 webp，可以将 `Vendor/WebP.framework`(静态库) 加入你的工程。
+5. 导入 `YYImage.h`。
+
+
+关于
+==============
+该项目最低支持 iOS 6.0。
+
+
+许可证
+==============
+YYModel 使用 MIT 许可证，详情见 LICENSE 文件。