update readme

zaihcodes · Mar 24, 2024 · 42f4993 · 42f4993
1 parent 48f0063
commit 42f4993
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,15 @@
-# hadeeth
+# موسوعة الأحاديث النبوية
+# Mawsouaat Al Ahadith
 
-A new Flutter project.
+## Overview
+This is a simple Flutter application that demonstrates effective state management using the BLoC (Business Logic Component) pattern. The project follows a clean architecture approach, separating concerns into three layers: Data, Domain, and Presentation. Additionally, it integrates with the hadeethenc API to fetch and display data.
+
+## Features
+BLoC Pattern: Utilizes the BLoC pattern for efficient state management, ensuring a clean separation of business logic from the UI.
+
+Clean Architecture: Adheres to a clean architecture by organizing code into three distinct layers - Data, Domain, and Presentation. This promotes modularity and maintainability.
+
+API Integration: Communicates with the https://hadeethenc.com/api/v1 API to retrieve and display data. You can easily replace this API with your own or any other API of your choice.
+
+## Screenshots
+![my screenshot](./screenshots/Screenshot.png)
diff --git a/screenshots/Screenshot.png b/screenshots/Screenshot.png
diff --git a/screenshots/Screenshot_1.png b/screenshots/Screenshot_1.png
diff --git a/screenshots/Screenshot_2.png b/screenshots/Screenshot_2.png
diff --git a/screenshots/Screenshot_3.png b/screenshots/Screenshot_3.png