Skip to content

Commit e40a2f9

Browse files
authored
Merge pull request #271 from arkivanov/update-docs-and-readme
Update docs and readme
2 parents 464ec15 + 1658040 commit e40a2f9

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,14 @@ Recommended minimum Gradle version is 5.3. Please read first the documentation a
4848
[metadata publishing mode](https://kotlinlang.org/docs/reference/building-mpp-with-gradle.html#experimental-metadata-publishing-mode).
4949

5050
There are a number of modules published to Maven Central:
51+
5152
- `mvikotlin` - core interfaces and functionality (multiplatform)
5253
- `mvikotlin-main` - the main module with the default `Store` implementation (mutiplatform)
5354
- `mvikotlin-logging` - logging functionality (mutiplatform)
5455
- `mvikotlin-timetravel` - time travel feature (mutiplatform)
5556
- `mvikotlin-extensions-reaktive` - extensions set for Reaktive library (multiplatform)
5657
- `mvikotlin-extensions-coroutines` - extensions set for coroutines (multiplatform)
57-
- `keepers` - provides `StateKeeper` and `InstanceKeeper` API for state preservation and objects retaining
58+
- ~~`keepers` - provides `StateKeeper` and `InstanceKeeper` API for state preservation and objects retaining~~ (deprecated)
5859
- `rx` - a tiny module with abstractions over rx and coroutines (multiplatform)
5960

6061
Add required modules to your module`s build.gradle file:
@@ -68,14 +69,15 @@ implementation "com.arkivanov.mvikotlin:<module-name>:<version>"
6869
* Extensions for [Reaktive](https://github.com/badoo/Reaktive) library
6970
* Extensions for [Coroutines](https://github.com/Kotlin/kotlinx.coroutines)
7071
* Multithreading friendly (freezable in Kotlin Native if needed)
72+
* Lifecycle-aware connections (bindins) between inputs and outputs
7173
* Logging functionality with customizable logger and formatter
7274
* Time travel feature:
73-
* Multiplatform for all supported targets
74-
* Plug-and-play UI for Android
75-
* Plug-and-play UI for iOS (copy-paste from the sample app)
76-
* Export/import events for Android
77-
* IDEA and Android Studio [plugin](https://plugins.jetbrains.com/plugin/14241-mvikotlin-time-travel) for Android apps
78-
* MacOS [client application](mvikotlin-timetravel-client/app-macos) for iOS and macOS apps
75+
* Multiplatform for all supported targets
76+
* Plug-and-play UI for Android
77+
* Plug-and-play UI for iOS (copy-paste from the sample app)
78+
* Export/import events for Android
79+
* IntelliJ IDEA and Android Studio [plugin](https://plugins.jetbrains.com/plugin/14241-mvikotlin-time-travel) for Android apps
80+
* Desktop [client application](mvikotlin-timetravel-client/app-desktop) for Android, Java and native Apple (iOS, watchOS, tvOS, macOS) apps
7981

8082
## Documentation
8183

@@ -84,7 +86,7 @@ implementation "com.arkivanov.mvikotlin:<module-name>:<version>"
8486
## Sample project
8587

8688
The sample project is a todo list with details view.
87-
* Shared module using Reaktive is [here](sample/todo-reaktive)
89+
* Shared module using Reaktive is [here](sample/todo-reaktive)
8890
* Shared module using coroutines is [here](sample/todo-coroutines)
8991
* Sample Android application with both Reaktive and coroutines implementations, plus logging and time travel is [here](sample/todo-app-android)
9092
* Sample iOS application with Reaktive implementation only, plus logging and time travel is [here](sample/todo-app-ios)

docs/time_travel.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,3 +100,10 @@ The time travel client application for desktop is not published yet so you will
100100
The time travel client for desktop is implemented using [Compose for Desktop](https://github.com/JetBrains/compose-jb). So it is possible to assemble a distributable version. Please read the corresponding [documentation page](https://github.com/JetBrains/compose-jb/tree/master/tutorials/Native_distributions_and_local_execution).
101101

102102
[Overview](index.md) | [Store](store.md) | [View](view.md) | [Binding and Lifecycle](binding_and_lifecycle.md) | [State preservation](state_preservation.md) | [Logging](logging.md) | Time travel
103+
104+
#### Demo videos
105+
106+
Check out the video demonstrating the time travel client app for macOS:
107+
108+
[![Debugging iOS application using MVIKotlin time travel client app](https://img.youtube.com/vi/rj6GwA2ZQkk/0.jpg)](https://youtu.be/rj6GwA2ZQkk)
109+

0 commit comments

Comments
 (0)