Maven Central integration

blipinsk · Apr 2, 2015 · 638cd69 · 638cd69
1 parent 62e5144
commit 638cd69
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,10 @@
 RecyclerViewHeader
-===============
+==================
 Super fast and easy way to create header for Android `RecyclerView`.
 
-![ ](/RecyclerViewHeader.png)
+Let's you create header `View` for any `RecyclerView` that uses `LinearLayoutManager` or `GridLayoutManager` with just a simple method call.
 
+![ ](/RecyclerViewHeader.png)
 
 Usage
 =====
@@ -13,7 +14,7 @@ Basically, there are two ways of using `RecyclerViewHeader`.
 
 **Regular approach** (super easy to use, but it uses additional `Layouts` so it's a bit less efficient than the second approach):
 
-  1. Create an xml layout file for your header (the file can contain any type of `View` or `ViewGroup`)
+  1. Create an xml layout file for your header (file can contain any type of `View` or `ViewGroup`)
 
         <FrameLayout
             android:layout_width="match_parent"
@@ -34,7 +35,7 @@ Basically, there are two ways of using `RecyclerViewHeader`.
   3. Attach `RecyclerViewHeader` to your `RecyclerView` and you're done!
 
         RecyclerView recyclerView = (RecyclerView) findViewById(R.id.recycler_view);
-        // setting LayoutManager for your RecyclerView
+        // set LayoutManager for your RecyclerView
         header.attachTo(recyclerView);
 
 **Header-already-aligned approach** (does not introduce any additional `Layouts`):
@@ -74,31 +75,36 @@ Basically, there are two ways of using `RecyclerViewHeader`.
   3. Attach `RecyclerViewHeader` to your `RecyclerView` (with `attachTo(RecyclerView recycler, boolean headerAlreadyAligned)`) and that's it.
 
         RecyclerView recyclerView = (RecyclerView) findViewById(R.id.recycler_view);
-        // setting LayoutManager for your RecyclerView
+        // set LayoutManager for your RecyclerView
         header.attachTo(recyclerView, true);
 
 
-**Important Notes:**
+Important notes
+---------------
 
 `RecyclerViewHeader` needs to be called after you've set the `LayoutManager` for your `RecyclerView`.
 
-Current implementation of the library can be used for `RecyclerViews` using `LinearLayoutManager` or `GridLayoutManager`.
+Current implementation of the library can be used for `RecyclerViews` that uses `LinearLayoutManager` or `GridLayoutManager`.
 
 If you were planning to use `setOnScrollListener(...)` method for your `RecyclerView`, be sure to do it before calling `attachTo(...)` method of the `RecyclerViewHeader`.
 
 
 Including In Your Project
 -------------------------
-I will upload the library to Maven Central as soon as I finish `Javadoc`.
+You can grab the library via Maven Central. Just add a proper dependency inside your `build.gradle`. Like this:
 
-It will be ready really, really soon... stay tuned.
+```xml
+dependencies {
+    compile 'com.bartoszlipinski.recyclerviewheader:library:1.0.0'
+}
+```
 
 Developed by
-==========
+============
  * Bartosz Lipiński
 
 License
-======
+=======
 
     Copyright 2015 Bartosz Lipiński
 

diff --git a/library/build.gradle b/library/build.gradle
@@ -23,3 +23,5 @@ dependencies {
     compile 'com.android.support:appcompat-v7:21.0.3'
     compile 'com.android.support:recyclerview-v7:21.0.3'
 }
+
+apply from: '../gradle-mvn-push.gradle'
diff --git a/library/gradle.properties b/library/gradle.properties
@@ -0,0 +1,3 @@
+POM_NAME=RecyclerViewHeader Library
+POM_ARTIFACT_ID=library
+POM_PACKAGING=aar
diff --git a/settings.gradle b/settings.gradle
@@ -1 +1 @@
-include ':sample', ':library'
+include ':library', ':sample'