CMP Ready

README.md

@@ -1,14 +1,49 @@
-This is a Kotlin Multiplatform project targeting Android, iOS.
+<p align="center">
+  <a href="https://rlujancreations.es/" target="blank"><img src="./githubimages/logo.png" width="300px" alt="RLujanCreations Logo" /></a>
+</p>
 
-* `/composeApp` is for code that will be shared across your Compose Multiplatform applications.
-  It contains several subfolders:
-  - `commonMain` is for code that’s common for all targets.
-  - Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name.
-    For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app,
-    `iosMain` would be the right folder for such calls.
+---
 
-* `/iosApp` contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform, 
-  you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.
+# MinesWeeper
+This is my version of the classic game Minesweeper, developed in Kotlin.
+** Updated to Compose Multi Platform**
+This game is available in Android and IOS
 
+The original version of this project is available on the brach **Kotlin**
 
-Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html)…
+## Main Features and Technologies Used
+- **Kotlin 2.0**: It is used to take advantage of its modern features and performance improvements, making it easier to develop a robust and efficient application.
+- **Jetpack Compose**: The user interface is developed using this modern Android UI toolkit, making it easy to create flexible and dynamic interfaces.
+- **MVVM**: Implements the Model-View-ViewModel pattern to separate presentation logic from business logic and data, improving testability and code organization.
+- **Dependency Injection - Koin ~~Dagger-Hilt~~ **: Used to simplify dependency management, allowing for better scalability and unit testing.
+- **Unit Test**: User interface tests to ensure the app behaves correctly and provides a smooth user experience.
+- **Flows**: Utilized to handle asynchronous data streams, providing a clean way to manage state and data flow within the application.
+- **DataStore Preferences**: It is used to save the best times of the user locally
+
+---
+
+## Screenshots
+
+| ![Home Screen](./githubimages/home.png) | ![Game Screen](./githubimages/game.png) |
+|:---------------------------------------:|:--------------------------------------:|
+|                 **Home**                |                **Game**                |
+| ![Home Screen](./githubimages/iosmenu.png) | ![Game Screen](./githubimages/iosgame.png) |
+|:---------------------------------------:|:--------------------------------------:|
+|                 **IOS Menu**                |                **IOS Game**                |
+| ![Game Win Screen](./githubimages/wingame.png) | ![Game Loss Screen](./githubimages/losegame.png) |
+|:----------------------------------------------:|:------------------------------------------------:|
+|                 **Game Win**                   |                 **Game Loss**                    |
+
+---
+
+## ToDo List
+
+- [X] End of game **status**
+- [X] Dialog Status End of Game
+- [X] Toast for alerts, only when the user has no more mines
+- [X] Animations, only in dialogs
+- [X] Persistence for saving records
+- [X] Show records on HomeScreen
+- [X] Board test created
+
+---