Skip to content

Commit

Permalink
📝 updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nisrulz committed Dec 4, 2018
1 parent 837eec3 commit fa7c86f
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,18 +76,31 @@
<br/>
<br/>


> Note: Development for pr-androidx version of this library has stopped. If you are looking for [pre-androidx version, then checkout this branch.](https://github.com/nisrulz/recyclerviewhelper/tree/archive/pre-androidx)
# Integration
RecyclerViewHelper is available in the Jcenter, so getting it as simple as adding it as a dependency
```gradle
def supportLibVersion="{latest version}"
def recyclerViewVersion="{latest version}"
// Required
implementation "androidx.recyclerview:recyclerview:${recyclerViewVersion}"
// RecyclerViewHelper
implementation "com.github.nisrulz:recyclerviewhelper:x${recyclerViewVersion}"
```
where `{latest version}` corresponds to published version in [ ![Download](https://api.bintray.com/packages/nisrulz/maven/com.github.nisrulz%3Arecyclerviewhelper/images/download.svg) ](https://bintray.com/nisrulz/maven/com.github.nisrulz%3Arecyclerviewhelper/_latestVersion) without the prepended `x`.
This is done to distinguish between library using andoirdx vs pre-androidx.

Usage Example:
```gradle
def recyclerViewVersion="1.0.0"
// Required
implementation "com.android.support:appcompat-v7:${supportLibVersion}"
implementation "com.android.support:recyclerview-v7:${supportLibVersion}"
implementation "androidx.recyclerview:recyclerview:${recyclerViewVersion}"
// RecyclerViewHelper
implementation "com.github.nisrulz:recyclerviewhelper:${supportLibVersion}"
implementation "com.github.nisrulz:recyclerviewhelper:x${recyclerViewVersion}"
```
where `{latest version}` corresponds to published version in [ ![Download](https://api.bintray.com/packages/nisrulz/maven/com.github.nisrulz%3Arecyclerviewhelper/images/download.svg) ](https://bintray.com/nisrulz/maven/com.github.nisrulz%3Arecyclerviewhelper/_latestVersion)

> NOTE : The version here corresponds to the version of recyclerview dependency.
Expand Down

0 comments on commit fa7c86f

Please sign in to comment.