Skip to content

Commit 11793f3

Browse files
committed
updated docs
1 parent 4064f38 commit 11793f3

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Simple RecyclerView Adapter
2-
[![](https://jitpack.io/v/horaciocome1/simple-recyclerview-adapter.svg)](https://jitpack.io/#horaciocome1/simple-recyclerview-adapter)[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0) [![API](https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=14)
2+
[![](https://jitpack.io/v/horaciocome1/simple-recyclerview-adapter.svg)](https://jitpack.io/#horaciocome1/simple-recyclerview-adapter) [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0) [![API](https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=14)
33

44
## Getting Started
55
This is a library that abstracts, and completely hide the Adapter and ViewHolder class creation part.
6-
It is general purpose object that can be costumized to each case (item layout) by the time of creation. Similar to what is done on Listview with default adapters.
6+
It is general purpose object that can be customized to each case (item layout) by the time of creation. Similar to what is done on Listview with default adapters.
77
Compatible with androidx.
88

9-
## Pre-requesites
10-
This library can be implemented on any android project with minimun API 14. You must have a list and an item_layout for each item of the list
9+
## Pre-requisites
10+
This library can be implemented on any android project with minimum API 14. You must have a list and an item_layout for each item of the list
1111

1212
## Adding to your project
1313
Lets start by adding a corresponding repository in your _root_ `build.gradle` file. (prefer below all other)
@@ -19,18 +19,18 @@ Lets start by adding a corresponding repository in your _root_ `build.gradle` fi
1919
}
2020
}
2121
```
22-
The next task is to add the dependecy to your _app_ `build.gradle` file.
22+
The next task is to add the dependency to your _app_ `build.gradle` file.
2323
```gradle
2424
dependencies {
2525
...
26-
implementation 'com.github.horaciocome1:simple-recyclerview-adapter:0.1.2'
26+
implementation 'com.github.horaciocome1:simple-recyclerview-adapter:0.1.3'
2727
}
2828
```
2929
Now you ready to go. Except that you should _**sync your project**_ first.
3030

31-
### Do not use with app compart or support design
32-
As mention on IO18, android support libraries will not be updated anymore, thats the main reason ive moved to androidx and new material design libraries. That's why if you have any appcompat or design support library as dependency the build will fail. Because the androidx on these lib will conflict with android support on your app.
33-
I am wondering if it is necessary to do a separate lib for suppor appcompat. Email me if you thinking on that.
31+
### Do not use with app compat or support design
32+
As mention on IO18, android support libraries will not be updated anymore, that's the main reason ive moved to androidx and new material design libraries. That's why if you have any appcompat or design support library as dependency the build will fail. Because the androidx on these lib will conflict with android support on your app.
33+
I am wondering if it is necessary to do a separate lib for support appcompat. Email me if you thinking on that.
3434

3535
## How to use
3636
Call the default constructor passing as Datatype the class of your list objects.
@@ -105,7 +105,7 @@ NONE OF THIS ARE OPTIONAL, so not setting them may lead to runtime app crash.
105105
recyclerView.adapter = SimpleRecyclerViewAdapter<DataType>()
106106
```
107107

108-
### "Build or sinchronization failed!"
108+
### "Build or synchronization failed!"
109109
This is might be a dependency matter. Please reference to the part on the start where i talked about support libraries.
110110

111111
## Licenses

0 commit comments

Comments
 (0)