Skip to content

Commit da37229

Browse files
committed
update:
Updated README style.
1 parent 8fdf306 commit da37229

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ dependencies {
3636
```
3737

3838
There are two common variants of using library: via [TutorialPageProvider] and via [TutorialPageOptionsProvider].
39-
##### Via TutorialPageProvider
39+
### Via TutorialPageProvider
4040
You have to create page fragments where each fragment must extend from [PageFragment], override [PageFragment#getLayoutResId()] and [PageFragment#getTransformItems()]. Also you have to create your layout xml file with images.
4141

4242
```java
@@ -98,7 +98,7 @@ public class CustomTutorialFragment extends TutorialFragment {
9898
}
9999
```
100100

101-
##### Via TutorialPageProvider
101+
### Via TutorialPageProvider
102102
Or you can create [TutorialPageOptionsProvider] and set it up to [TutorialOptions.Builder#setTutorialPageProvider(TutorialPageOptionsProvider)]. It will automatically provide [PageFragment] instance with specified [PageOptions] configuration.
103103

104104
```java
@@ -175,7 +175,7 @@ public class CustomTutorialFragment extends TutorialFragment {
175175
```
176176

177177
## Customization
178-
##### Set up skip button click listener
178+
### Set up skip button click listener
179179
You have to implement *OnClickListener* interface and provide it to [TutorialOptions.Builder#setOnSkipClickListener(OnClickListener)]. Example:
180180
```java
181181
public class CustomTutorialFragment extends TutorialFragment {
@@ -194,7 +194,7 @@ public class CustomTutorialFragment extends TutorialFragment {
194194
}
195195
```
196196

197-
##### Set up pages colors
197+
### Set up pages colors
198198
Just provide array of color values to [TutorialOptions.Builder#setPagesColors(int array)]. Array with colors **must have length equal to pages size**.
199199
```java
200200
public class CustomTutorialFragment extends TutorialFragment {
@@ -213,13 +213,13 @@ public class CustomTutorialFragment extends TutorialFragment {
213213
}
214214
}
215215
```
216-
##### Infinite scroll
216+
### Infinite scroll
217217
To loop tutorial pages you have set [TutorialOptions.Builder#setUseAutoRemoveTutorialFragment(boolean)] to **Boolean**#*TRUE*.
218218

219-
##### Auto remove TutorialFragment - scroll from last tutorial page to your content
219+
### Auto remove TutorialFragment - scroll from last tutorial page to your content
220220
If you want to provide smooth transition from last tutorial page to content - just set up [TutorialOptions.Builder#setUseAutoRemoveTutorialFragment(boolean)] to **Boolean**#*TRUE*.
221221

222-
##### Indicator view customization
222+
### Indicator view customization
223223
There is [IndicatorOptions] class for configuration indicator view. Here's example:
224224
```java
225225
public class CustomTutorialFragment extends TutorialFragment {
@@ -245,7 +245,7 @@ Also in sample module there are two implementaions:
245245
* [DrawableRenderer]
246246
* [RhombusRenderer]
247247

248-
##### Add OnTutorialPageChangeListener
248+
### Add OnTutorialPageChangeListener
249249
You can listen change page listener - just implement [TutorialFragment.OnTutorialPageChangeListener] and add listener via [TutorialFragment#addOnTutorialPageChangeListener(OnTutorialPageChangeListener)]. To remove listener use [TutorialFragment#removeOnTutorialPageChangeListener(OnTutorialPageChangeListener)].
250250
```java
251251
public class CustomTutorialFragment extends TutorialFragment

0 commit comments

Comments
 (0)