Add README

Author: Chris Banes

README.md

@@ -0,0 +1,113 @@
+# ActionBar-PullToRefresh
+
+
+ActionBar-PullToRefresh provides an easy way to add a modern version of the pull-to-refresh interaction to your application.
+
+Please note that this is __not__ an update to [Android-PullToRefresh](https://github.com/chrisbanes/Android-PullToRefresh), this has been created from new. You should think of this as Android-PullToRefresh's younger, leaner cousin.
+
+### This is a Preview
+Please note that this is currently in a preview state. This basically means that the API is not fixed and you should expect changes between releases.
+
+---
+
+## Supported Views
+
+ActionBar-PullToRefresh has in-built support for:
+
+ * AbsListView derivatives (ListView & GridView).
+ * ScrollView
+
+If the View you want to use is not listed above, you can easily add support by providing a `Delegate`. See the 'Delegates' section below for more info.
+
+---
+
+## Usage
+There are two ways to use this library, programmatically or declaratively.
+
+### Programmatically
+You just need to create an instance of `PullToRefreshAttacher`, giving it the Activity and the View for which will scroll.
+
+``` java
+private PullToRefreshAttacher mPullToRefreshHelper;
+
+@Override
+public void onCreate(Bundle savedInstanceState) {
+    super.onCreate(savedInstanceState);
+        
+    // Get View for which the user will scroll…
+    View scrollableView = findViewById(R.id.blah); 
+
+    mPullToRefreshHelper = new PullToRefreshAttacher(this, scrollableView);
+    mPullToRefreshHelper.setRefreshListener(this);
+}
+```
+
+__See the [ListView]() sample for more info.__
+  
+### Declaratively
+Here you just wrap your scrollable view in a `PullToRefreshLayout` in your layout XML:
+
+``` xml
+<uk.co.senab.actionbarpulltorefresh.library.PullToRefreshLayout
+    android:id="@+id/ptr_layout"
+    xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:ptr="http://schemas.android.com/apk/res-auto"
+    android:layout_width="fill_parent"
+    android:layout_height="fill_parent"
+    ptr:refreshScrollDistance="0.75">
+
+    <ScrollView
+        android:layout_width="fill_parent"
+        android:layout_height="fill_parent"
+        android:padding="8dp"
+        android:scrollbarStyle="outsideInset">
+
+        <TextView
+            android:layout_width="fill_parent"
+            android:layout_height="wrap_content"
+            android:text="@string/filler_text" />
+
+    </ScrollView>
+
+</uk.co.senab.actionbarpulltorefresh.library.PullToRefreshLayout>
+```
+In you Activity/Fragment you then do the following to retrieve the generated PullToRefreshAttacher
+
+``` java
+// Retrieve PullToRefreshAttacher from PullToRefreshLayout
+mPullToRefreshAttacher = PullToRefreshLayout.getAttacher(this, R.id.ptr_layout);
+
+// Set Listener to know when a refresh should be started
+mPullToRefreshAttacher.setRefreshListener(this);
+```
+
+__See the [ScrollView]() sample for more info.__
+
+---
+
+## Customisation    
+    
+### Delegates
+TODO
+
+### HeaderTransformers
+TODO
+
+
+---
+
+## License
+
+    Copyright 2013 Chris Banes
+
+    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.