You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updated more docs for 2.0 and added a navigation sample (airbnb#492)
I went through a bunch of the docs and:
* Updated some for naming/API changes
* Added navigation docs + a sample app
* Updated the docs theme and sidebar organization
* Rewrote some parts of the docs I found confusing
Copy file name to clipboardexpand all lines: docs/README.md
+8-11
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,15 @@
3
3
4
4
# Mavericks
5
5
6
-
Mavericks is an Android MVI framework that is both easy to learn yet powerful enough for the most complex flows at Airbnb and other large apps.
6
+
Mavericks is an Android MVI framework that is both easy to learn yet powerful enough for the most complex flows at [Airbnb](https://www.airbnb.com/), [Tonal](http://tonal.com/), and other large apps.
7
7
8
8
When we began creating Mavericks, our goal was to make building products easier, faster, and more fun. We believe that for Mavericks to be successful, it must be easy to learn for people new to Android development working their first apps yet powerful enough to support the most complex screens at Airbnb.
9
9
10
10
Mavericks is used in hundreds of screens at Airbnb including 100% of new screens. It has also been adopted by countless other apps from small smaple apps to apps with over 1 billion downloads.
11
11
12
-
Mavericks is built on top of [Android Jetpack](https://developer.android.com/jetpack) so it can be thought of as a complement rather than a departure from Google's standard set of libraries.
12
+
Mavericks is built on top of [Android Jetpack](https://developer.android.com/jetpack)and [Kotlin Coroutines](https://developer.android.com/kotlin/coroutines)so it can be thought of as a complement rather than a departure from Google's standard set of libraries.
13
13
14
-
This is what it looks like:
14
+
This is what a simple screen looks like. More complex screens may have more state properties or ViewModel functions but they rarely get much more complex to debug or hard to read.
15
15
```kotlin
16
16
/** State classes contain all of the data you need to render a screen. */
17
17
data classCounterState(valcount:Int = 0) : MavericksState
@@ -21,7 +21,7 @@ class CounterViewModel(initialState: CounterState) : MavericksViewModel<CounterS
privateval viewModel:CounterViewModel by activityViewModel()
27
27
@@ -37,11 +37,8 @@ class CounterFragment : Fragment(R.layout.counter_fragment), MavericksView {
37
37
}
38
38
```
39
39
40
-
## Installation
40
+
## Introduction to Mavericks (Droidcon Italy 2019)
41
41
42
-
```groovy
43
-
dependencies {
44
-
implementation 'com.airbnb.android:mvrx:x.y.z'
45
-
}
46
-
```
47
-
The latest version of mvrx is [](https://maven-badges.herokuapp.com/maven-central/com.airbnb.android/mvrx)
42
+
This conference talk was designed for MvRx 1.0 but nearly all of the concepts still apply.
0 commit comments