From 6a7448c60f5326e454dc9cc7abc2a4df7a8328bb Mon Sep 17 00:00:00 2001
From: Running man! <littleximail@gmail.com>
Date: Fri, 8 Apr 2016 04:47:06 +0800
Subject: [PATCH] Create README.md

---
 README.md | 114 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 114 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..142e33f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,114 @@
+# IRecyclerView
+IRecyclerView is a custom RecyclerView that supports pull-to-refresh, pull-to-loadmore, customize refresh header and loadmore footer, add header views and footer views.
+
+### Features:
+- pull-to-refresh
+- pull-to-loadmore
+- customize refresh header
+- customize loadmore footer
+- add multiple header view
+- add multiple footer view
+
+### Demo
+[Download](https://github.com/Aspsine/IRecyclerView/blob/master/art/demo.apk?raw=true)
+
+### Demo ScreenShot
+- Bat Man vs Super Man Refresh header
+
+![Bat Man vs Super Man](https://github.com/Aspsine/IRecyclerView/raw/master/art/bat_vs_supper_header.gif)
+
+- Classic Refresh header
+
+![classic](https://github.com/Aspsine/IRecyclerView/raw/master/art/class_header.gif)
+
+- Load more footer
+
+![load more](https://github.com/Aspsine/IRecyclerView/raw/master/art/load_more.gif)
+
+### How to use
+Step 1. Add the JitPack repository to your build file. Add it in your root build.gradle at the end of repositories:
+```groovy
+allprojects {
+    repositories {
+        ...
+        maven { url "https://jitpack.io" }
+    }
+}
+```
+Step 2. Add the dependency
+```groovy
+dependencies {
+    compile 'com.github.Aspsine:IRecyclerView:1.0.0'
+}
+```
+Step 3. Edit your Activity/Fragment content view layout
+```xml
+<com.aspsine.irecyclerview.IRecyclerView xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:id="@+id/iRecyclerView"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    app:loadMoreEnabled="true"
+    app:loadMoreFooterLayout="@layout/layout_irecyclerview_load_more_footer"
+    app:refreshEnabled="true"
+    app:refreshHeaderLayout="@layout/layout_irecyclerview_refresh_header"/>
+```
+Then Editor your Activity/Fragment
+
+```java
+IRecyclerView iRecyclerView = (IRecyclerView) findViewById(R.id.iRecyclerView);
+
+iRecyclerView.setLayoutManager(new LinearLayoutManager(this));
+
+// an custom footer view, you can customize it yourself.
+LoadMoreFooterView loadMoreFooterView = (LoadMoreFooterView) iRecyclerView.getLoadMoreFooterView();
+
+// you can also add header and footer like this
+// note: header and refresh header are different, footer and load more footer are different too. 
+iRecyclerView.addHeaderView(headerView);
+iRecyclerView.addFooterView(footerView);
+
+// adapter
+ImageAdapter mAdapter = new ImageAdapter();
+// note: here use setIAdapter(...) method not setAdapter(...)
+iRecyclerView.setIAdapter(mAdapter);
+
+iRecyclerView.setOnRefreshListener(new OnRefreshListener() {
+    @Override
+    public void onRefresh() {
+    
+    }
+});
+iRecyclerView.setOnLoadMoreListener(new OnLoadMoreListener() {
+    @Override
+    public void onLoadMore(View loadMoreView) {
+
+    }
+});
+```
+
+Please check out the demo code for more details .
+
+### Contact Me
+- Github: github.com/aspsine
+- Email:  littleximail@gmail.com
+- WeiBo:  [@Aspsine](http://weibo.com/wetze)
+
+### License
+
+    Copyright 2016 Aspsine. All rights reserved.
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+