更新readme

README.md

@@ -1,4 +1,81 @@
-zepto.fullpage
+zepto.fullpage [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/yanhaijing/zepto.fullpage/blob/master/MIT-LICENSE.txt)
 ==============
 
-专注于移动端的fullpage
+专注于移动端的fullpage.js，依赖Zepto。
+
+##功能概述
+可实现移动端的单页滚动效果，可自定义参数，提供回调接口，和公开接口。
+
+##兼容性
+
+- Ios4+
+- Andriod2.3+（未全部覆盖）
+
+##快速上手
+###HTML
+
+	<div class="wp">
+        <div class="wp-inner">
+            <div class="page page1">1</div>
+            <div class="page page2">2</div>
+            <div class="page page3">3</div>
+            <div class="page page4">4</div>
+        </div>
+    </div>
+
+###CSS
+父容器需是固定高度，并且移除为隐藏，fullpage会使用父元素的宽度和高度。
+
+	.wp{
+	    overflow: hidden;            
+	}
+
+##js
+一行代码即可完成，如此简单：
+
+	$('.wp-inner').fullpage();
+
+**注意：实在.wp-inner上调用的。**
+
+更多例子，请移步[这里](demo)。
+
+##文档
+
+[API](doc/api.md)
+
+##贡献指南
+
+如果你想为zepto.fullpage贡献代码，请采用fork + pull request 方式，并在发起pr前先将master上超前的代码rebase到自己的分支上。
+
+##报告问题
+
+- [Issues](https://github.com/yanhaijing/zepto.fullpage/issues "报告问题")
+
+##作者
+
+**yanhaijing**
+
+- [Weibo](http://weibo.com/yanhaijing1234 "yanhaijing's Weibo")
+- [Email](mailto:[email protected] "yanhaijing's Email")
+- [Blog](http://yanhaijing.com "yanhaijing's Blog")
+
+##为什么会有这个项目
+最近单页滚动的效果非常流行，这种效果的视觉冲击感很强烈，特别是对于活动页面，因为需求的迫切，在pc端诞生了 fullPage.js和onepage-scroll这样的库，在移动的浪潮下，我们自然需要把这种效果搬到移动设备上，但当我在想实现类似效果时，却找不到一个这样的库（fullpage.js对于移动端来说太大了，还要依赖jquery），所以我就开发了一个，先是用于自己项目中，后来抽了出来，就有了这个项目。
+
+##更新日志
+
+[更新日志](CHANGELOG.md)
+
+##TODO
+- 循环滚动
+- 横向滚屏
+
+##谁在使用
+**注:如果您也在使用，欢迎反馈给我**
+
+- [百度知道](http://zhidao.baidu.com/s/5_0-page/index.html)
+
+##相关链接
+- [fullPage.js](https://github.com/alvarotrigo/fullPage.js)
+- [onepage-scroll](https://github.com/peachananr/onepage-scroll)
+- [parallax.js](https://github.com/hahnzhu/parallax.js)