Merge pull request #9 from Freedisch/dev

Dev

README.md

@@ -1,16 +1,33 @@
-# SafetyCall
 
-A new Flutter project.
+# SAFETYCALL
 
-## Getting Started
+An emergency alert application.
 
-This project is a starting point for a Flutter application.
+## INTRODUCTION
 
-A few resources to get you started if this is your first Flutter project:
+This application is designed to provide assistance in times of emergency, specifically targeting individuals who are susceptible to falls and require immediate help. The app employs automated fall detection technology by utilizing pre-installed cameras in user's, and manual alert mechanisms to ensure swift alert to pre-selected contacts.
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+## FEATURES
 
-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 reference.
+- **Camera-based Fall Detection**: The app utilizes installed cameras in the user's house to detect falls automatically. This feature is particularly useful for individuals who are prone to falling due to health conditions.
+-
+- **Manual Alert Button**: Users can also manually trigger alerts by pressing a dedicated button within the mobile application interface. This allows for quick and easy communication with emergency contacts when needed.
+-
+- **Contact List Management**: Users can pre-select a list of emergency contacts within the app. These contacts will receive notifications in case of an emergency, ensuring that help can be swiftly summoned.
+-
+- **Location Sharing**: The app can share the user's location with emergency contacts, helping responders locate them quickly in case of an emergency.
+
+## USAGE
+
+- **Fall Detection**: Allow pre-installed cameras to monitor your movements while you go about your daily activities. If a fall is detected, the app will automatically trigger an alert to your emergency contacts.
+
+- **Manual Alert**: In case of an emergency that does not involve a fall, open the app and press the manual alert button. This will immediately notify your chosen emergency contacts of the situation.
+
+- **Response**: Once an alert is triggered, your emergency contacts will receive notifications according to your configured preferences. Responders can then take appropriate action to assist you.
+
+## CONTRIBUTORS
+
+- [Thibaut Batale](https://github.com/Freedisch)
+- [Samuel Olubode](https://github.com/SundayOlubode)
+- [Wubeshet Yimam](https://github.com/wubeshetA)
+- [Martin Ndungu](https://github.com/gichuri)