Skip to content

Commit 82be3df

Browse files
committed
docs: update README
1 parent 3e89463 commit 82be3df

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@ Makes the use of RecyclerView easier, modular and less error-prone.
44

55
Standard `RecyclerView.Adapter` is tedious to work with, because you have to write repetitive boilerplate and spaghetti code and to concentrate all your items view logic and binding into the adapter itself, which is really bad. This library was born to be able to have the following for each element in a recycler view:
66

7-
* an XML layout file, in which to define the item's view hierarchy
8-
* a view model file (called `Item`), in which to specify the binding between the model and the view and in which to handle user interactions with the item.
7+
* a `model`, which is a simple `data class`
8+
* a programmatic `View` or an XML layout file, in which to define the item's view hierarchy
9+
* a `view model` file (called `AdapterItem`), in which to specify the binding between the model and the view and in which to handle user interactions with the item.
910

1011
In this way every item of the recycler view has its own set of files, resulting in a cleaner and easier to maintain code base.
1112

13+
This allows also to write completely declarative UIs, using stock Android View system and be able to already write something similar to [JetPack Compose](https://developer.android.com/jetpack/compose) and use it in production.
14+
1215
# Index
1316

1417
* [Setup](#setup)
@@ -36,10 +39,10 @@ In this way every item of the recycler view has its own set of files, resulting
3639
## <a name="setup"></a>Setup
3740
In your gradle dependencies add:
3841
```groovy
39-
def recyclerAdapterVersion = "2.9.0" // change it with the version you want to use
42+
def recyclerAdapterVersion = "x.y.z" // change it with the version you want to use
4043
implementation "net.gotev:recycleradapter:$recyclerAdapterVersion"
4144
```
42-
This is the latest Bintray version: [ ![Download](https://api.bintray.com/packages/gotev/maven/recycler-adapter/images/download.svg) ](https://bintray.com/gotev/maven/recycler-adapter/_latestVersion)
45+
This is the latest version: [ ![Download](https://api.bintray.com/packages/gotev/maven/recycler-adapter/images/download.svg) ](https://bintray.com/gotev/maven/recycler-adapter/_latestVersion)
4346

4447
Due to some prolonged Bintray outages, an alternative maven repo has been set. If the dependencies are not resolved, add this to your maven repos:
4548

0 commit comments

Comments
 (0)