Skip to content

Commit f45db40

Browse files
committed
Update README.md
**It's thundering atm. Shutting off PC until it passes. Documentation incomplete.**
1 parent 60baa9e commit f45db40

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ maven {
2828

2929
```gradle
3030
dependencies {
31-
compile 'com.turingtechnologies.materialscrollbar:lib:3.+'
31+
compile 'com.turingtechnologies.materialscrollbar:lib:34+'
3232
}
3333
```
3434

@@ -37,12 +37,10 @@ How to use - ScrollBar
3737
For version 3.0.0 and later, all you need to add is this line of code:
3838

3939
```java
40-
MaterialScrollBar materialScrollBar = new MaterialScrollBar(this, recyclerView);
40+
MaterialScrollBar materialScrollBar = new MaterialScrollBar(this, recyclerView, {{lightOnTouch}});
4141
```
4242

43-
where 'recyclerView' is the recyclerView to which you want to link the scrollBar.
44-
45-
If you're updating from an older version, remove any xml from this library and rewrite your code to implement the API as above.
43+
where 'recyclerView' is the recyclerView to which you want to link the scrollBar. "lightOnTouch" can either be true or false. A value of true will cause the handle to be grey until pressed, when it will become the normal accent colour (as set). A value of false will cause the handle to always have the accent colour, even when not being pressed.
4644

4745
It is also strongly recommended that you provide the accent colour if your app supports devices below Lollipop. You can do this by invoking:
4846

@@ -59,9 +57,11 @@ How to use - Section Indicator
5957
To add a section indicator, simply add the following line of code:
6058

6159
```java
62-
materialScrollBar.addSectionIndicator(this);
60+
materialScrollBar.addSectionIndicator({{Section Indicator}});
6361
```
6462

63+
The section indicator should be either AlphatbetIndicator, DateAndTimeIndicator, or CustomIndicator. See below for specific instructions per indicator. **It's thundering atm. Shutting off PC until it passes. Documentation incomplete.**
64+
6565
To use a section indicator, you **MUST** make your recyclerView's adapter implement INameableAdapter. If you do not, the library will throw a runtime error informing you of your mistake.
6666

6767
Versioning Policy

0 commit comments

Comments
 (0)