Skip to content

Commit 89c8a02

Browse files
committed
Update README.md with new app screenshots and enhanced documentation sections
1 parent 18b792f commit 89c8a02

1 file changed

Lines changed: 47 additions & 6 deletions

File tree

README.md

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ A comprehensive tutorial project showcasing **Decompose** for building reactive,
1010

1111
Decompose provides powerful tools for creating independent UI components with their own lifecycle, state management, and navigation capabilities. This tutorial walks through implementing a Todo application with clean architecture principles and Decompose integration.
1212

13-
<!-- TODO: Add screenshot of the app here -->
14-
![App Screenshot](screenshots/app_screenshot.png)
13+
![App Overview](assets/9.Screenshot_20250508_072837.png)
1514

1615
## ✨ Key Features
1716

@@ -21,6 +20,47 @@ Decompose provides powerful tools for creating independent UI components with th
2120
- **Back Stack Management**: Support for navigation history
2221
- **Lifecycle Management**: Clean component lifecycle handling
2322

23+
## 📱 App Screenshots
24+
25+
### Todo List View
26+
<p align="center">
27+
<img src="assets/10.Screenshot_20250508_072856.png" width="250" alt="Todo List"/>
28+
<img src="assets/11.Screenshot_20250508_072905.png" width="250" alt="Creating New Todo"/>
29+
</p>
30+
31+
### Todo Workflow Stages
32+
<p align="center">
33+
<img src="assets/12.Screenshot_20250508_072916.png" width="250" alt="Todo Stage"/>
34+
<img src="assets/13.Screenshot_20250508_072923.png" width="250" alt="In Progress Stage"/>
35+
<img src="assets/14.Screenshot_20250508_072929.png" width="250" alt="Done Stage"/>
36+
</p>
37+
38+
### Todo Details and Editing
39+
<p align="center">
40+
<img src="assets/15.Screenshot_20250508_072938.png" width="250" alt="Todo Details"/>
41+
<img src="assets/16.Screenshot_20250508_072944.png" width="250" alt="Edit Todo"/>
42+
</p>
43+
44+
### Navigation and State Handling
45+
<p align="center">
46+
<img src="assets/17.Screenshot_20250508_073045.png" width="250" alt="Navigation Example 1"/>
47+
<img src="assets/18.Screenshot_20250508_073051.png" width="250" alt="Navigation Example 2"/>
48+
</p>
49+
50+
### Component Interaction
51+
<p align="center">
52+
<img src="assets/19.Screenshot_20250508_073058.png" width="250" alt="Component Interaction 1"/>
53+
<img src="assets/20.Screenshot_20250508_073102.png" width="250" alt="Component Interaction 2"/>
54+
</p>
55+
56+
### Advanced Features
57+
<p align="center">
58+
<img src="assets/21.Screenshot_20250508_073108.png" width="250" alt="Advanced Feature 1"/>
59+
<img src="assets/22.Screenshot_20250508_073120.png" width="250" alt="Advanced Feature 2"/>
60+
<img src="assets/23.Screenshot_20250508_073124.png" width="250" alt="Advanced Feature 3"/>
61+
<img src="assets/24.Screenshot_20250508_073127.png" width="250" alt="Advanced Feature 4"/>
62+
</p>
63+
2464
## 🏗️ Architecture
2565

2666
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.
@@ -154,8 +194,11 @@ stateDiagram-v2
154194
- Display: Checkbox (checked)
155195
- Action: Unchecking the box moves todo back to "Todo" stage
156196

157-
<!-- TODO: Add screenshots for each stage -->
158-
![Todo Stages](screenshots/todo_stages.png)
197+
<p align="center">
198+
<img src="assets/12.Screenshot_20250508_072916.png" width="250" alt="Todo Stage"/>
199+
<img src="assets/13.Screenshot_20250508_072923.png" width="250" alt="In Progress Stage"/>
200+
<img src="assets/14.Screenshot_20250508_072929.png" width="250" alt="Done Stage"/>
201+
</p>
159202

160203
## 💻 Component Implementation
161204

@@ -226,8 +269,6 @@ fun `when todo is clicked, it navigates to details screen`() {
226269
}
227270
```
228271

229-
<!-- TODO: Add more test examples -->
230-
231272
## 👨‍💻 About the Author
232273

233274
**Abdelraouf Sabri** - Senior Android Developer

0 commit comments

Comments
 (0)