Skip to content

Commit a69b5b6

Browse files
committed
improve the readme
1 parent 29b995d commit a69b5b6

File tree

3 files changed

+11
-13
lines changed

3 files changed

+11
-13
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ This is a simple, easy-to-implement, and highly customizable framework for makin
88

99
The goal of this library isn't to confine you to certain UI styles or guidelines that I have made. The goal here is to provide you with a framework that you can build off of yourself. The content of these tutorial pages can be anything you want. That said, I have provided a few examples here, of UIs that have worked well for me and that I think provide a pretty great experience.
1010

11-
*Note: the library itself is in [Kotlin](https://kotlinlang.org/), which is now [native to Android](https://blog.jetbrains.com/kotlin/2017/05/kotlin-on-android-now-official/). I have created sample applications in both* **Kotlin** *and* **Java**. *So, as you go through and figure out how to implement this library, you can use either sample as a reference. They are functionally equivalent.*
12-
13-
*If you would like to see the usage section of this README in* **Java** *please head to the [Java-flavored README](README-JAVA.md).*
11+
> *Note: the library itself is in [Kotlin](https://kotlinlang.org/), which is now [native to Android](https://blog.jetbrains.com/kotlin/2017/05/kotlin-on-android-now-official/). I have created sample applications in both* **Kotlin** *and* **Java**. *The samples are functionally equivalent. If you would like to see the usage section of this README in* **Java** *please head to the [Java-flavored README](README_JAVA.md).*
1412
1513
## Including it in your Project
1614

@@ -71,7 +69,7 @@ object : TutorialPage(this@SimpleDialogExample) {
7169
})
7270
```
7371

74-
Any other customization you want can come directly from your layout file. My examples show the primary color for the background of the top text. You could do that inside of your layout, if you like that look.
72+
Any other customization can come directly from your layout file. My examples show the primary color for the background of the top text. You could do that inside of your layout, if you like that look.
7573

7674
### Animating the layouts
7775

@@ -97,15 +95,15 @@ object : TutorialPage(this@SimpleDialogExample) {
9795

9896
If you would rather animate the `View` every time the page is shown, you could override the `TutorialPage#onShown(firstTimeShown: Boolean)` method, instead. If you override that, be sure to call the super class method.
9997

100-
### Providing results from the individual pages, or the entire tutorial
98+
### Providing `TutorialPage` and `Activity` Results
10199

102100
<p align="center">
103101
<img src="artwork/result_data.gif">
104102
</p>
105103

106-
Sometimes, you may need to have some state in your tutorial. If you are using the tutorial to log in a user, for example, you will probably need the calling `Activity` to know if the login was successful or not.
104+
Sometimes, you may need store and provide some kind of state within the tutorial. For example: if you are using the tutorial to log in a user, you will probably need the calling `Activity` to know if the login was successful or not.
107105

108-
For an example of how to provide an `Activity` result from your `TutorialPage`, please see the [SelectionDialogExample](sample-kotlin/src/main/java/xyz/klinker/floating_tutorial/examples/SelectionDialogExample.kt).
106+
Please see the [SelectionDialogExample](sample-kotlin/src/main/java/xyz/klinker/floating_tutorial/examples/SelectionDialogExample.kt) as an example of providing the calling `Activity` the result of your `FloatingTutorialActivity`.
109107

110108
Other times, you may need to know the result of the previous page, to display the UI for the next page. In the [RateItExample](sample-kotlin/src/main/java/xyz/klinker/floating_tutorial/examples/RateItExample.kt), the first page asks the user to give a thumbs up or thumbs down.
111109

@@ -130,7 +128,7 @@ Please fork this repository and contribute back using [pull requests](https://gi
130128

131129
## Changelog
132130

133-
The full changelog for the library can be found [here](https://github.com/klinker24/Android-FloatingTutorialActivity/blob/master/CHANGELOG.md).
131+
The full changelog for the library can be found [here](CHANGELOG.md).
134132

135133
## License
136134

README_JAVA.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# Android Floating Tutorial Activity
66

7-
This README discusses the usage of the tutorial in **Java** rather than **Kotlin**, which is demonstrated in the [README.md](README.md).
7+
This README discusses the usage of the tutorial in **Java** rather than **Kotlin**. **Kotlin** usage is shown in the [README.md](README.md). The **Java** and **Kotlin** sample apps are functionally equivalent.
88

99
## Usage
1010

@@ -63,7 +63,7 @@ new TutorialPage(context) {
6363
})
6464
```
6565

66-
Any other customization you want can come directly from your layout file. My examples show the primary color for the background of the top text. You could do that inside of your layout, if you like that look.
66+
Any other customization can come directly from your layout file. My examples show the primary color for the background of the top text. You could do that inside of your layout, if you like that look.
6767

6868
### Animating the layouts
6969

@@ -90,15 +90,15 @@ new TutorialPage(context) {
9090

9191
If you would rather animate the `View` every time the page is shown, you could override the `TutorialPage#onShown(firstTimeShown: Boolean)` method, instead. If you override that, be sure to call the super class method.
9292

93-
### Providing results from the individual pages, or the entire tutorial
93+
### Providing `TutorialPage` and `Activity` Results
9494

9595
<p align="center">
9696
<img src="artwork/result_data.gif">
9797
</p>
9898

99-
Sometimes, you may need to have some state in your tutorial. If you are using the tutorial to log in a user, for example, you will probably need the calling `Activity` to know if the login was successful or not.
99+
Sometimes, you may need store and provide some kind of state within the tutorial. For example: if you are using the tutorial to log in a user, you will probably need the calling `Activity` to know if the login was successful or not.
100100

101-
For an example of how to provide an `Activity` result from your `TutorialPage`, please see the [SelectionDialogExample](sample-java/src/main/java/xyz/klinker/floating_tutorial/examples/SelectionDialogExample.java).
101+
Please see the [SelectionDialogExample](sample-java/src/main/java/xyz/klinker/floating_tutorial/examples/SelectionDialogExample.java) as an example of providing the calling `Activity` the result of your `FloatingTutorialActivity`.
102102

103103
Other times, you may need to know the result of the previous page, to display the UI for the next page. In the [RateItExample](sample-java/src/main/java/xyz/klinker/floating_tutorial/examples/RateItExample.java), the first page asks the user to give a thumbs up or thumbs down.
104104

artwork/feature.xcf

2.35 MB
Binary file not shown.

0 commit comments

Comments
 (0)