Skip to content

Commit ed9a3c2

Browse files
docs(README): refactor readme
add video preview rewrite architecture section and add missing info rewrite CI/CD section
1 parent 427a1d6 commit ed9a3c2

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,24 @@ The first screen shows the list of all products. The second screen shows the det
88

99
## Architecture
1010

11-
The project uses BLoC pattern with rxdart for state management, riverpod for dependency injection and freezed for data classes
11+
* BLoC + rxdart for state management
12+
* riverpod for dependency injection
13+
* dio for network requests and REST API
14+
* freezed for data classes
15+
* bloc_test for unit testing BLoCs
16+
* mockito for mocking dependencies
1217

1318
## Continuous Deployment
1419

1520
The project uses GitHub Actions for continuous deployment
1621

17-
The workflow runs tests and builds the app for Android then uploads the APK to GitHub releases
22+
The workflow runs tests then builds the app for Android if all tests succeed, and finally uploads the APK to GitHub releases
1823

19-
You can download the APK from the latest release [here](https://github.com/Andrew-Bekhiet/slash_dot/releases/latest)
24+
You can download the APK from the [latest release](https://github.com/Andrew-Bekhiet/slash_dot/releases/latest)
2025

2126
## Screenshots and Video
2227

23-
### [Video Link](screenshots/video.mp4)
28+
https://github.com/Andrew-Bekhiet/slash_dot/assets/40571928/3f63651e-f8ca-4ba5-a7cb-e2e1062960f8
2429

2530
<img src="screenshots/1.png" width="350">
2631
<img src="screenshots/2.png" width="350">

0 commit comments

Comments
 (0)