Skip to content

Commit a94e04e

Browse files
committed
Updated README.md
1 parent 8434e9e commit a94e04e

File tree

1 file changed

+3
-57
lines changed

1 file changed

+3
-57
lines changed

README.md

Lines changed: 3 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,6 @@
1-
# MAD-Example
2-
This simple Todo app showcases the Modern Android Development and best practices while developing android apps.
3-
4-
### This Simple Note app showcases the Modern Android approach when working with Room Offline database
5-
6-
**This App will build upon on**
7-
8-
* `Android Views (XML)`.
9-
* Room database for local db.
10-
* Preference Datastore for stroring user Preference.
11-
* Dagger Hilt for Dependency Injection.
12-
* Navigation Component to navigate between fragment.
13-
* Reactive Ui using Kotlin Flows and Coroutines.
14-
* Implemented Settings using PreferenceSettingCompat library.
1+
# Compose Sample
2+
This simple app shows how to create a chat screen in compose this repo is bases on compose basic in official android page
153

164
### Note 👀
175

18-
**This App doesn't focus on Building Modern Material Ui the UI looks clean and straightforward to use**
19-
**and also i doesn't add tons of feature's i implement new feature step by step along with**
20-
21-
focus on Architecture that include's
22-
23-
Structuring Package's for clean architecture
24-
25-
Per Screen ViewModel for Ui related logic
26-
27-
Kotlin Flows for Reactive UI, and other.
28-
29-
### Features ✅
30-
31-
CRUD opeations For Notes
32-
33-
1. Search note through [Room FTS](https://developer.android.com/training/data-storage/room/defining-data#fts)
34-
35-
2. [Dynamic theme](https://developer.android.com/develop/ui/views/theming/dynamic-colors) Android 12+.
36-
37-
3. Dark Theme and Light theme control through settings.
38-
39-
4. and other Miscellaneous features...
40-
41-
42-
### Improvements 🚀
43-
44-
**This app currently is in development new features might be added some important feature you can expect that include 🚧**
45-
46-
* Reminder's with Notification.
47-
48-
* Advance FTS search (now i only implemented basic search feature).
49-
50-
* Sorting and filtering the note and some others.
51-
52-
* Probably i can switch Views to `compose`.
53-
54-
### Contribution 🤝
55-
56-
If you like to contribute this project you can do it
57-
58-
As i already mention this project primarly focus on Architecture use `MVVM` and SOLID Principle.
59-
60-
All features and improvement should be commited on `features` or `improvement` branch not main.
6+
**This App doesn't focus on Building Modern Material Ui the UI looks clean**

0 commit comments

Comments
 (0)