public 🔥

LICENSE

@@ -1,21 +1 @@
-MIT License
-
-Copyright (c) 2023 Petrus Nguyễn Thái Học
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+TODO - TBD - WIP

README.md

@@ -15,6 +15,7 @@
 ![badge][badge-tvos]
 ![badge][badge-watchos]
 
+TODO - TBD - WIP
 <p align="center">
     <img src="https://github.com/hoc081098/kmp-viewmodel/raw/master/logo.png" width="400">
 </p>
@@ -80,23 +81,52 @@ bus
 
 ## Docs
 
-TODO
+TODO - TBD - WIP
+
+## Sample
+
+- [Android Compose sample](https://github.com/hoc081098/kotlin-channel-event-bus/tree/master/sample/app):
+  an Android app using Compose UI to show how to use the library.
+  It has two nested navigation graphs: `RegisterScreen` and `HomeScreen`.
+
+  In `RegisterScreen`, we have 3 steps (3 screens) to allow user to input their information, step by
+  step.
+  - A `RegisterSharedViewModel` (bound to `RegisterScreen` navigation graph scope) is used
+    to hold the whole state of the registration process.
+    It observes events from the `ChannelEventBus` and update the state accordingly.
+
+  - Each step screen has a `ViewModel` to hold the state of the screen, and will send events to
+    the `ChannelEventBus`,
+    then the `RegisterSharedViewModel` will receive those events and update the state.
+
+## Roadmap
+
+TODO - TBD - WIP
 
 ## License
 
 ```license
-MIT License
-Copyright (c) 2023 Petrus Nguyễn Thái Học
+TODO - TBD - WIP
 ```
 
 [badge-android]: http://img.shields.io/badge/android-6EDB8D.svg?style=flat
+
 [badge-ios]: http://img.shields.io/badge/ios-CDCDCD.svg?style=flat
+
 [badge-js]: http://img.shields.io/badge/js-F8DB5D.svg?style=flat
+
 [badge-jvm]: http://img.shields.io/badge/jvm-DB413D.svg?style=flat
+
 [badge-linux]: http://img.shields.io/badge/linux-2D3F6C.svg?style=flat
+
 [badge-windows]: http://img.shields.io/badge/windows-4D76CD.svg?style=flat
+
 [badge-mac]: http://img.shields.io/badge/macos-111111.svg?style=flat
+
 [badge-watchos]: http://img.shields.io/badge/watchos-C0C0C0.svg?style=flat
+
 [badge-tvos]: http://img.shields.io/badge/tvos-808080.svg?style=flat
+
 [badge-wasm]: https://img.shields.io/badge/wasm-624FE8.svg?style=flat
+
 [badge-nodejs]: https://img.shields.io/badge/nodejs-68a063.svg?style=flat