Merge remote and local README

Author: abd3lraouf

.github/workflows/blank.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: gradle
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Abdelraouf Sabri
+
+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.

README.md

@@ -1,10 +1,28 @@
 # Decompose Tutorial
 
-This project demonstrates how to use the Decompose library with clean architecture and feature-based packaging in an Android app.
+![Kotlin](https://img.shields.io/badge/kotlin-1.9.0-blue.svg?logo=kotlin)
+![Compose](https://img.shields.io/badge/Jetpack_Compose-Latest-green.svg?logo=jetpackcompose)
+![Decompose](https://img.shields.io/badge/Decompose-2.1.0-purple.svg)
 
-## Architecture
+A comprehensive tutorial project showcasing Decompose for reactive UI component architecture in Kotlin Android development.
 
-The project follows Clean Architecture principles with a feature-based package structure. This approach allows for better separation of concerns, high cohesion, and easier maintainability.
+## 🚀 Overview
+
+Decompose is a powerful Kotlin library for building component-based UIs with clean separation of concerns. This tutorial demonstrates how to create modular, maintainable Android applications using Decompose with Jetpack Compose.
+
+## ✨ Key Features
+
+- **Component-Based Architecture**: Modular UI components with encapsulated logic
+- **State Management**: Reactive state with unidirectional data flow
+- **Type-Safe Navigation**: Navigation between components without Fragments
+- **Back Stack Management**: Support for navigation history
+- **Lifecycle Management**: Clean component lifecycle handling
+
+## 🏗️ Architecture
+
+This project follows Clean Architecture principles with a feature-based package structure combined with Decompose component architecture. This approach allows for better separation of concerns, high cohesion, and easier maintainability.
+
+![Architecture Diagram](https://raw.githubusercontent.com/abd3lraouf/decompose-tutorial/master/assets/architecture.svg)
 
 ### Package Structure
 
@@ -66,22 +84,42 @@ The app uses Decompose's navigation capabilities:
 2. **Tab Navigation**: Managed by `TabNavigationComponent` for switching between features
 3. **Stack Navigation**: Each feature (like TodoList) has its own stack navigation for its screens
 
-### Clean Architecture Benefits
+## 📋 Todo App Implementation
+
+This tutorial implements a Todo application with a three-stage workflow:
 
-- **Separation of Concerns**: Each layer has a clear responsibility
-- **Testability**: Domain and data layers can be tested independently of the UI
-- **Flexibility**: Easy to change implementations without affecting other parts of the application
-- **Scalability**: New features can be added without modifying existing ones
+1. **Todo Stage**:
+   - Display: Play button (no checkbox)
+   - Action: Clicking play button moves todo to "In Progress" stage
 
-### Feature-Based Benefits
+2. **In Progress Stage**:
+   - Display: Checkbox
+   - Action: Checking the box moves todo to "Done" stage
 
-- **High Cohesion**: Related code stays together
-- **Low Coupling**: Features are independent of each other
-- **Parallel Development**: Multiple developers can work on different features simultaneously
-- **Clear Boundaries**: Dependencies between features are explicit
+3. **Done Stage**:
+   - Display: Checkbox (checked)
+   - Action: Unchecking the box moves todo back to "Todo" stage
 
-## Getting Started
+## 🛠️ Setup Instructions
 
 1. Clone the repository
-2. Open in Android Studio
-3. Run the app on an emulator or physical device 
+2. Open the project in Android Studio
+3. Build and run the app
+
+## 📚 Technologies
+
+- **Kotlin**: Modern programming language
+- **Jetpack Compose**: UI toolkit
+- **Decompose**: Component architecture
+- **Kotlin Coroutines**: Asynchronous programming
+
+## 👨‍💻 About the Author
+
+**Abdelraouf Sabri** - Senior Android Developer
+
+- Website: [abd3lraouf.dev](https://abd3lraouf.dev)
+- GitHub: [@abd3lraouf](https://github.com/abd3lraouf)
+
+---
+
+⭐️ Star this repository if you find it helpful!