diff --git a/README.md b/README.md index b78052d0..197ed2f0 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,55 @@

-# GroupTrack - Stay connected, Anywhere! +# Grouptrack - Stay connected, Anywhere! Enhancing family safety and communication with real-time location sharing and modern UIs. cover ## Overview -Welcome to GroupTrack, an open-source Android application designed to enhance family safety through real-time location sharing and communication features. GroupTrack aims to provide peace of mind by ensuring the safety of your loved ones and facilitating seamless communication regardless of their location. +Welcome to Grouptrack, an open-source Android application designed to enhance family safety through real-time location sharing and communication features. Grouptrack aims to provide peace of mind by ensuring the safety of your loved ones and facilitating seamless communication regardless of their location. -GroupTrack adopts the MVVM architecture pattern and leverages Jetpack Compose for building modern UIs declaratively. This architecture ensures a clear separation of concerns, making the codebase more maintainable and testable. Jetpack Compose simplifies UI development by allowing developers to define UI elements and their behavior in a more intuitive way, resulting in a seamless user experience. +Grouptrack adopts the MVVM architecture pattern and leverages Jetpack Compose for building modern UIs declaratively. This architecture ensures a clear separation of concerns, making the codebase more maintainable and testable. Jetpack Compose simplifies UI development by allowing developers to define UI elements and their behavior in a more intuitive way, resulting in a seamless user experience. ## Download App - ## Features -GroupTrack is currently in active development 🚧, with plans to incorporate additional features shortly. +Grouptrack is currently in active development 🚧, with plans to incorporate additional features shortly. -GroupTrack ensures your loved ones' well-being with: +Grouptrack ensures your loved ones' well-being with: - [X] Real-time Location Sharing - [X] Secure Communication - [X] Location History with Routes - [X] Geo-fencing +- [X] End-to-End Encryption - [ ] SOS Help Alert +## Security Features + +### End-to-End Encryption +Grouptrack ensures the privacy and security of your data by implementing end-to-end encryption. This encryption method ensures that only the group members can access the location data, preventing unauthorized access by third parties. + +- 🔐 **Signal Protocol Integration** + - Leverages the industry-leading Signal Protocol for end-to-end encryption + - Provides advanced cryptographic protection for all shared location data + +- 🔒 **Comprehensive Data Protection** + - All location data are encrypted before transmission + - Encryption keys are uniquely generated for each user and space + - No third-party, including Grouptrack servers, can access unencrypted data + +- 🔑 **Advanced Encryption Mechanisms** + - Utilizes industry-standard encryption algorithms (e.g., AES-256) + - Implements secure key exchange protocols + - Ensures data integrity and confidentiality + +- 🛡️ **Privacy Guarantees** + - Encryption happens client-side before data leaves the device + - Encrypted data is stored securely with no server-side decryption + +*Note: End-to-end encryption ensures that only intended group member can decrypt and view shared information.* + ## Screenshots @@ -70,14 +95,14 @@ Use the `applicationId` value specified in the `app/build.gradle` file of the ap Once the project is created, you will need to add the `google-services.json` file to the app module. For more information, refer to the [Firebase documentation](https://firebase.google.com/docs/android/setup). -GroupTrack uses the following Firebase services, Make sure you enable them in your Firebase project: +Grouptrack uses the following Firebase services, Make sure you enable them in your Firebase project: - Authentication (Phone, Google) - Firestore (To store user data) ## Tech stack -GroupTrack utilizes the latest Android technologies and adheres to industry best practices. Below is the current tech stack used in the development process: +Grouptrack utilizes the latest Android technologies and adheres to industry best practices. Below is the current tech stack used in the development process: - MVVM Architecture - Jetpack Compose @@ -100,13 +125,13 @@ GroupTrack utilizes the latest Android technologies and adheres to industry best The Canopas team enthusiastically welcomes contributions and project participation! There are a bunch of things you can do if you want to contribute! The [Contributor Guide](CONTRIBUTING.md) has all the information you need for everything from reporting bugs to contributing entire new features. Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear. ## Credits -GroupTrack is owned and maintained by the [Canopas team](https://canopas.com/). You can follow them on X at [@canopassoftware](https://x.com/canopassoftware) for project updates and releases. If you are interested in building apps or designing products, please let us know. We'd love to hear from you! +Grouptrack is owned and maintained by the [Canopas team](https://canopas.com/). You can follow them on X at [@canopassoftware](https://x.com/canopassoftware) for project updates and releases. If you are interested in building apps or designing products, please let us know. We'd love to hear from you! ## License -GroupTrack is licensed under the Apache License, Version 2.0. +Grouptrack is licensed under the Apache License, Version 2.0. ``` Copyright 2024 Canopas Software LLP diff --git a/screenshots/cover_image.png b/screenshots/cover_image.png index 74a64d20..f6842456 100644 Binary files a/screenshots/cover_image.png and b/screenshots/cover_image.png differ