docs: 📝 Added to the readme

README.md

@@ -6,7 +6,36 @@
 
 Generated by the [Very Good CLI][very_good_cli_link] 🤖
 
-My Offline First Chat
+# Offline First Chat App
+
+An offline-first chat application built using **Flutter**, **Supabase**, and
+**PowerSync**. The app allows real-time messaging with offline support, enabling
+users to continue chatting seamlessly even without an internet connection. When
+the connection is restored, the app synchronizes messages automatically.
+
+## Features
+
+- **Offline-First Approach**: Users can send and receive messages even while
+  offline. Messages are queued and synced when the internet connection is
+  restored.
+- **Real-Time Messaging**: Leverages Supabase for real-time messaging and data
+  synchronization.
+- **Authentication**: User authentication with Supabase for secure login and
+  registration.
+- **PowerSync Integration**: Manages offline storage and sync operations,
+  ensuring that all data is persisted locally and synced reliably.
+- **Push Notifications**: Get notified of new messages even when the app is
+  closed or running in the background.
+- **Flutter**: Cross-platform support for iOS and Android.
+- **Supabase**: Backend as a Service (BaaS) for real-time data synchronization
+  and authentication.
+
+## Tech Stack
+
+- **Flutter**: Frontend framework for building the app UI and logic.
+- **Supabase**: Backend service for real-time data, authentication, and storage.
+- **PowerSync**: Sync engine that manages offline data storage and synchronizes
+  when back online.
 
 ---
 
@@ -18,7 +47,8 @@ This project contains 3 flavors:
 - staging
 - production
 
-To run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands:
+To run the desired flavor either use the launch configuration in VSCode/Android
+Studio or use the following commands:
 
 ```sh
 # Development
@@ -43,7 +73,8 @@ To run all unit and widget tests use the following command:
 $ flutter test --coverage --test-randomize-ordering-seed random
 ```
 
-To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov).
+To view the generated coverage report you can use
+[lcov](https://github.com/linux-test-project/lcov).
 
 ```sh
 # Generate Coverage Report
@@ -57,11 +88,14 @@ $ open coverage/index.html
 
 ## Working with Translations 🌐
 
-This project relies on [flutter_localizations][flutter_localizations_link] and follows the [official internationalization guide for Flutter][internationalization_link].
+This project relies on [flutter_localizations][flutter_localizations_link] and
+follows the
+[official internationalization guide for Flutter][internationalization_link].
 
 ### Adding Strings
 
-1. To add a new localizable string, open the `app_en.arb` file at `lib/l10n/arb/app_en.arb`.
+1. To add a new localizable string, open the `app_en.arb` file at
+   `lib/l10n/arb/app_en.arb`.
 
 ```arb
 {
@@ -103,7 +137,8 @@ Widget build(BuildContext context) {
 
 ### Adding Supported Locales
 
-Update the `CFBundleLocalizations` array in the `Info.plist` at `ios/Runner/Info.plist` to include the new locale.
+Update the `CFBundleLocalizations` array in the `Info.plist` at
+`ios/Runner/Info.plist` to include the new locale.
 
 ```xml
     ...
@@ -164,7 +199,8 @@ To use the latest translations changes, you will need to generate them:
 flutter gen-l10n --arb-dir="lib/l10n/arb"
 ```
 
-Alternatively, run `flutter run` and code generation will take place automatically.
+Alternatively, run `flutter run` and code generation will take place
+automatically.
 
 [coverage_badge]: coverage_badge.svg
 [flutter_localizations_link]: https://api.flutter.dev/flutter/flutter_localizations/flutter_localizations-library.html