[Documentation] Improved the readme md file to start the project

Author: md-weber

README.md

@@ -1,16 +1,32 @@
+[![Dart](https://github.com/md-weber/flashcard_project/actions/workflows/dart.yml/badge.svg?branch=main)](https://github.com/md-weber/flashcard_project/actions/workflows/dart.yml)
+
 # flashcard_project
 
 Flashcard app connected with Google Spreadsheet
 
 ## Getting Started
 
-This project is a starting point for a Flutter application.
+This is a [Flutter](https://flutter.dev/) Project that works on iOS, Android, Web and MacOS.
+
+## Adding more Flashcards
+
+If you want to contribute to the Flashcards that will available in the App feel free to add more
+spreadsheets and folders to the following Link:
+
+[Google Drive - Flashcard](https://drive.google.com/drive/folders/1cov64m0rLhmFvkR5aJftoqBweJP7Lsgs?usp=sharing)
+
+Make sure to keep the folder structure as following:
+
+- Name of Lecture (Parent Folder)
+    - Lesson (Spreadsheet)
+
+## Tests
+
+This package uses mockito and build runner, so before you run your tests you will need to execute:
+`flutter packages pub run build_runner build`
+
+## Contributors ✨
 
-A few resources to get you started if this is your first Flutter project:
+-- Coming Soon --
 
-- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
 
-For help getting started with Flutter, view our
-[online documentation](https://flutter.dev/docs), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.