浏览代码

updated readme

ibireme 9 年之前
父节点
当前提交
3df00f342d
共有 1 个文件被更改,包括 15 次插入4 次删除
  1. 15 4
      README.md

+ 15 - 4
README.md

@@ -116,9 +116,15 @@ Installation
 5. Import `YYWebImage.h`.
 
 
-About
+Documentation
 ==============
-This library supports iOS 6.0 and later.
+Full API documentation is available on [CocoaDocs](http://cocoadocs.org/docsets/YYWebImage/).<br/>
+You can also install documentation locally using [appledoc](https://github.com/tomaz/appledoc).
+
+
+Requirements
+==============
+This library requires a deployment target of iOS 6.0 or greater.
 
 
 License
@@ -238,8 +244,12 @@ YYWebImage 是一个异步图片加载框架 ([YYKit](https://github.com/ibireme
 4. 如果你需要支持 webp,可以将 `Vendor/WebP.framework`(静态库) 加入你的工程。
 5. 导入 `YYWebImage.h`。
 
+文档
+==============
+你可以在 [CocoaDocs](http://cocoadocs.org/docsets/YYWebImage/) 查看在线 API 文档,也可以用 [appledoc](https://github.com/tomaz/appledoc) 本地生成文档。
+
 
-关于
+系统要求
 ==============
 该项目最低支持 iOS 6.0。
 
@@ -250,5 +260,6 @@ YYWebImage 使用 MIT 许可证,详情见 LICENSE 文件。
 
 相关链接
 ==============
-[移动端图片格式调研](http://blog.ibireme.com/2015/11/02/mobile_image_benchmark/)
+[移动端图片格式调研](http://blog.ibireme.com/2015/11/02/mobile_image_benchmark/)<br/>
+
 [iOS 处理图片的一些小 Tip](http://blog.ibireme.com/2015/11/02/ios_image_tips/)