adding details to readme

README.md

@@ -1,9 +1,3 @@
-# Screens
-<a href="https://ibb.co/3v31xpN"><img src="https://i.ibb.co/xYkhn1j/1-20221019-151648-0000.png" alt="1-20221019-151648-0000" border="0"></a>
-<a href="https://ibb.co/TKgqFSC"><img src="https://i.ibb.co/q0rFPfZ/5-20221019-151648-0004.png" alt="5-20221019-151648-0004" border="0"></a>
-<a href="https://ibb.co/gVPS1Lx"><img src="https://i.ibb.co/fvnkRzs/2-20221019-151648-0001.png" alt="2-20221019-151648-0001" border="0"></a>
-<a href="https://ibb.co/Tkx1jsn"><img src="https://i.ibb.co/nbNBdFV/4-20221019-151648-0003.png" alt="4-20221019-151648-0003" border="0"></a>
-<a href="https://ibb.co/ZT8cxWs"><img src="https://i.ibb.co/GP2CRcw/3-20221019-151648-0002.png" alt="3-20221019-151648-0002" border="0"></a>
 
 # Getting Started
 
@@ -16,4 +10,94 @@ A few resources to get you started if this is your first Flutter project:
 
 For help getting started with Flutter development, view the
 [online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API r
+samples, and guidance on mobile development
+
+# Notat
+
+ Notat is a simple note-taking app with a markdown editor and clean interface, it features: 
+
+* creating, editing, and deleting notes
+
+* markdown editor that allows making highly customizble notes
+
+* organizing notes in folders and more
+
+## Screenshots
+<a href="https://ibb.co/3v31xpN"><img src="https://i.ibb.co/xYkhn1j/1-20221019-151648-0000.png" alt="1-20221019-151648-0000" border="0"></a>
+<a href="https://ibb.co/TKgqFSC"><img src="https://i.ibb.co/q0rFPfZ/5-20221019-151648-0004.png" alt="5-20221019-151648-0004" border="0"></a>
+<a href="https://ibb.co/gVPS1Lx"><img src="https://i.ibb.co/fvnkRzs/2-20221019-151648-0001.png" alt="2-20221019-151648-0001" border="0"></a>
+<a href="https://ibb.co/Tkx1jsn"><img src="https://i.ibb.co/nbNBdFV/4-20221019-151648-0003.png" alt="4-20221019-151648-0003" border="0"></a>
+<a href="https://ibb.co/ZT8cxWs"><img src="https://i.ibb.co/GP2CRcw/3-20221019-151648-0002.png" alt="3-20221019-151648-0002" border="0"></a>
+
+## planned features 🌱
+
+* data encryption
+* locking notes
+* creating and editing notes offline[1]
+##### [1] due to a bug caused by firebase firestore, users are only able to create and edit notes online, [for more info](https://community.flutterflow.io/c/discuss-and-get-help/navigate-action-not-working-if-device-offline)
+
+## Used packages:
+ firebase_messaging: ^12.0.1 
+
+uuid: ^3.0.6 
+
+flutter_staggered_grid_view: ^0.6.2 
+
+auto_size_text: ^3.0.0 
+
+tab_indicator_styler: ^2.0.0 
+
+flutter_quill: ^5.4.1 
+
+loading_animation_widget: ^1.2.0+2 
+
+google_fonts: ^3.0.1 
+
+animated_text_kit: ^4.2.2
+
+lottie: ^1.4.1
+
+custom_timer: ^0.1.2
+
+jiffy: ^5.0.0
+
+focused_menu: ^1.0.5 
+
+flutter_riverpod: ^1.0.4 
+
+connectivity_plus: ^2.3.9 
+
+flutter_launcher_icons: ^0.9.2 
+
+flutter_native_splash: ^2.0.1+1 
+
+firebase_storage: ^10.3.4 
+
+cloud_firestore: ^3.4.2
+
+firebase_auth: ^3.6.1 
+
+firebase_core: ^1.20.0 
+
+## Usage
+* clone the project
+```
+https://github.com/Dev-Salem/notat.git
+```
+* Create a new Firebase project from the [console](https://console.firebase.google.com/).
+
+* Configure the Firebase for each platform.
+
+## Installation
+Notat isn't available on the app store yet, but you can try it by installing the apk from [here](https://www.mediafire.com/file/wuhhrx7jiali3pc/notat+v2.apk/file)
+
+## Contributing
+
+You can contribute by reporting bugs, suggesting improvements, and/or by helping out in code.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+
+## Acknowledgement
+Special thanks for these designers for inspiring me [1](https://dribbble.com/shots/11875872-A-simple-and-lightweight-note-app), [2](https://dribbble.com/shots/14995291--Notes-App-Dark-Mode)