Updated Readme

README.md

@@ -1,16 +1,52 @@
-# companion_rebuild
+# Companion App
 
-A new Flutter project.
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-## Getting Started
+Companion App is a mobile application built using Flutter, Node.js, and Supabase. It allows students to easily organize and share digital documents among a community of people. Students can rate the quality of digital documents shared and have all their notes present under one application.
 
-This project is a starting point for a Flutter application.
+## Table of Contents
 
-A few resources to get you started if this is your first Flutter project:
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
 
-- [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.
+- Upload and share digital documents
+- Personal notes management
+- Secure login and authentication
+
+## Installation
+
+To run the app, follow these steps:
+
+1. Clone the repository: `git clone https://github.com/tanishq5414/Companion.git`
+2. Install dependencies for the frontend and backend by running the following commands in separate terminal windows:
+   - `flutter pub get` 
+3. Create a Firebase project and enable Supabase database and Authentication.
+4. Add your Firebase project's `google-services.json` file to the `/android/app` directory.
+5. Run the app on a device or emulator by running `flutter run`.
+
+## Usage
+
+To use the app, create an account and log in. You can then upload and share digital documents, rate and provide feedback on documents shared by others, and manage your personal notes. You can also communicate with other students using the community chat feature.
+
+## Contributing
+
+Contributions to Companion App are welcome and encouraged! To contribute, follow these steps:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bug fix: `git checkout -b my-new-feature`.
+3. Make changes and commit them: `git commit -am 'Add some feature'`.
+4. Push to the branch: `git push origin my-new-feature`.
+5. Submit a pull request.
+
+## License
+
+Companion App is licensed under the MIT License. See the `LICENSE` file for more information.
+
+## Download
+
+Download the app on the Play Store: [https://play.google.com/store/apps/details?id=com.lightheads.companion.app](https://play.google.com/store/apps/details?id=com.lightheads.companion.app)