Merge remote-tracking branch 'origin/master'

README.md

@@ -1,4 +1,100 @@
-android-swipelistview
-=====================
+# android-swipelistview
 
-An Android List View implementation with support for drawable cells and many other swipe related features
+An Android List View implementation with support for drawable cells and many other swipe related features.
+
+- [Introduction](#introduction)
+- [Download](#download)
+  - [Maven Dependency](#maven-dependency)
+	- [APKLib and others](#apklib-and-others)
+	- [Dependencies](#dependencies)
+- [XML Usage](#xml-usage)
+
+# Introduction
+
+SwipeListView was born out of the need to add swipe gestures to ListView on Android for 
+@ [47 Degrees](http://47deg.com) Clients. Contributions and constructive feedback are welcome.
+
+# Download
+
+## Maven Dependency
+
+SwipeListView may be automatically imported into your project if you already use [Maven](http://maven.apache.org/). 
+Just declare android-swipelistview as a maven dependency.
+If you wish to always use the latest unstable snapshots, add the Sonatype repository where the SwipeListView 
+snapshot artifacts are being deployed.
+SwipeListView official releases will be made available at Maven Central.
+
+```xml
+<repository>
+    <id>sonatype</id>
+    <url>https://oss.sonatype.org/content/groups/public/</url>
+    <releases>
+        <enabled>true</enabled>
+        <updatePolicy>daily</updatePolicy>
+        <checksumPolicy>fail</checksumPolicy>
+    </releases>
+    <snapshots>
+        <enabled>true</enabled>
+        <updatePolicy>always</updatePolicy>
+        <checksumPolicy>ignore</checksumPolicy>
+    </snapshots>
+</repository>
+
+<dependency>
+    <groupId>com.fortysevendeg.android</groupId>
+    <artifactId>swipelistview</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <type>apklib</type>
+</dependency>
+```
+## APKLib and others
+
+You can get the releases, snapshots and other forms in which SwipeListView is distributed from the
+[Downloads](https://github.com/47deg/android-swipelistview/downloads) page.
+
+## Dependencies
+
+SwipeListView depends on the following libraries.
+
+- com.nineoldandroids 
+
+SwipeListView expects that you include one of the Google Android [compatibility libraries](http://developer.android.com/intl/es/tools/extras/support-library.html) in order to use Loaders in versions that do not support them natively.
+Depending on your requirements you may choose to include one of the following...
+
+- com.google.android :
+    - support-v4 (Available in Maven Central)
+
+# XML Usage
+
+If you decide to use SwipeListView as a view, you can define it in your xml layout like this:
+
+```xml
+    <com.fortysevendeg.android.swipelistview.SwipeListView
+            xmlns:swipe="http://schemas.android.com/apk/res-auto"
+            android:id="@+id/example_lv_list"
+            android:listSelector="#00000000"
+            android:layout_width="fill_parent"
+            android:layout_height="wrap_content"
+            swipe:swipeFrontView="@+id/front"
+            swipe:swipeBackView="@+id/back"
+            swipe:swipeActionLeft="[reveal | dismiss]"
+            swipe:swipeActionRight="[reveal | dismiss]"
+            swipe:swipeMode="[none | both | right | left]"
+            swipe:swipeCloseAllItemsWhenMoveList="[true | false]"
+            swipe:swipeOpenOnLongPress="[true | false]"
+            swipe:swipeAnimationTime="[miliseconds]"
+            swipe:swipeOffsetLeft="[dimension]"
+            swipe:swipeOffsetRight="[dimension]"
+            />
+```
+
+* `swipeFrontView` - **Required** - front view id.
+* `swipeBackView` - **Required** - back view id.
+* `swipeActionLeft` - Optional - left swipe action Default: 'reveal'
+* `swipeActionRight` - Optional - right swipe action Default: 'reveal'
+* `swipeMode` - Gestures to enable or 'none'. Default: 'both'
+* `swipeCloseAllItemsWhenMoveList` - Close revealed items on list motion. Default: 'true'
+* `swipeOpenOnLongPress` - Reveal on long press Default: 'true'
+* `swipeAnimationTime` - item drop animation time. Default: android configuration
+* `swipeOffsetLeft` - left offset
+* `swipeOffsetRight` - right offset