Skip to content

Commit 2b56884

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

1 file changed

Lines changed: 38 additions & 7 deletions

File tree

README.md

Lines changed: 38 additions & 7 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,43 @@ 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+
## 📱 Screenshot Gallery
24+
25+
Below is a comprehensive table of all screenshots demonstrating different aspects of the application:
26+
27+
| Category | Screenshot | Description | Key Concepts |
28+
|----------|------------|-------------|-------------|
29+
| **Overview** | ![App Overview](assets/9.Screenshot_20250508_072837.png) | Main app overview showing the Todo list interface | Root component visualization, Overall app layout |
30+
| **Todo Management** | ![Todo List](assets/10.Screenshot_20250508_072856.png) | Todo list displaying items in different stages | List component, Item rendering |
31+
| | ![Creating Todo](assets/11.Screenshot_20250508_072905.png) | Interface for creating a new Todo item | Form handling, User input |
32+
| **Workflow Stages** | ![Todo Stage](assets/12.Screenshot_20250508_072916.png) | Todo in initial stage with play button | State representation, Action buttons |
33+
| | ![In Progress Stage](assets/13.Screenshot_20250508_072923.png) | Todo in "In Progress" stage | State transition, Progress tracking |
34+
| | ![Done Stage](assets/14.Screenshot_20250508_072929.png) | Todo in "Done" stage with checked checkbox | Completion state, Visual feedback |
35+
| **Item Details** | ![Todo Details](assets/15.Screenshot_20250508_072938.png) | Detailed view of a Todo item | Detail component, Information display |
36+
| | ![Edit Todo](assets/16.Screenshot_20250508_072944.png) | Interface for editing a Todo item | Edit mode, Form validation |
37+
| **Navigation** | ![Navigation 1](assets/17.Screenshot_20250508_073045.png) | Navigation between screens | Stack navigation, Component transition |
38+
| | ![Navigation 2](assets/18.Screenshot_20250508_073051.png) | Back navigation handling | Back stack, Component preservation |
39+
| **Component Interaction** | ![Interaction 1](assets/19.Screenshot_20250508_073058.png) | Components communicating with each other | Event handling, Component communication |
40+
| | ![Interaction 2](assets/20.Screenshot_20250508_073102.png) | State update between components | State propagation, Reactive updates |
41+
| **Advanced Features** | ![Advanced 1](assets/21.Screenshot_20250508_073108.png) | Filtering and sorting capabilities | Filter component, State manipulation |
42+
| | ![Advanced 2](assets/22.Screenshot_20250508_073120.png) | Todo statistics and metrics | Analytics component, Data aggregation |
43+
| | ![Advanced 3](assets/23.Screenshot_20250508_073124.png) | Settings and configuration options | Preferences component, User customization |
44+
| | ![Advanced 4](assets/24.Screenshot_20250508_073127.png) | Theme switching and appearance options | Theme component, Visual customization |
45+
46+
### Visual Tour of Todo States
47+
48+
The following sequence illustrates the lifecycle of a Todo item as it progresses through different states:
49+
50+
<p align="center">
51+
<img src="assets/12.Screenshot_20250508_072916.png" width="250" alt="Todo Stage"/>
52+
<img src="assets/13.Screenshot_20250508_072923.png" width="250" alt="In Progress Stage"/>
53+
<img src="assets/14.Screenshot_20250508_072929.png" width="250" alt="Done Stage"/>
54+
</p>
55+
56+
1. **Todo Stage**: Initial state with play button to begin task
57+
2. **In Progress Stage**: Active task with unchecked checkbox
58+
3. **Done Stage**: Completed task with checked checkbox
59+
2460
## 🏗️ Architecture
2561

2662
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,9 +190,6 @@ stateDiagram-v2
154190
- Display: Checkbox (checked)
155191
- Action: Unchecking the box moves todo back to "Todo" stage
156192

157-
<!-- TODO: Add screenshots for each stage -->
158-
![Todo Stages](screenshots/todo_stages.png)
159-
160193
## 💻 Component Implementation
161194

162195
A simple Decompose component looks like:
@@ -226,8 +259,6 @@ fun `when todo is clicked, it navigates to details screen`() {
226259
}
227260
```
228261

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

233264
**Abdelraouf Sabri** - Senior Android Developer

0 commit comments

Comments
 (0)