From 9ea465df89baeef7dfa815def04f442253f6e0cd Mon Sep 17 00:00:00 2001
From: Andrew Trieu <andrew.trieu@kempower.com>
Date: Tue, 27 Feb 2024 13:56:36 +0200
Subject: [PATCH] Add README.md

---
 README.md     | 30 ++++++++++++++++++++++++++++++
 composer.json |  1 +
 2 files changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c0bdf15
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# ChatLine - Real-time Messaging App
+
+ChatLine is a real-time messaging app that allows users to send and receive messages in real-time. Users can create an account, log in, and send messages to other users. The app is built using JavaScript, PHP, and MySQL.
+
+## Features
+
+- User authentication
+- Real-time messaging
+- User search
+- User online/offline status
+- User last seen status
+
+## Deployment
+
+The app is deployed on Heroku. You can access the app [here](https://chatline-f5e4ccce6986.herokuapp.com/).
+
+## Local Setup
+
+1. Clone the repository
+2. Install [XAMPP](https://www.apachefriends.org/index.html)
+3. Start the Apache and MySQL servers
+4. Create a new database in phpMyAdmin
+5. Import the `chatline.sql` file into the database
+6. Update the database credentials in `config.php`
+7. Copy the repository to the `htdocs` folder in the XAMPP directory
+8. Open the app in a web browser using the URL `http://<your-localhost>/chatline/`
+
+## Disclaimer
+
+Based on [this project](https://www.youtube.com/watch?v=VnvzxGWiK54&ab_channel=CodingNepal).
diff --git a/composer.json b/composer.json
index e69de29..0967ef4 100644
--- a/composer.json
+++ b/composer.json
@@ -0,0 +1 @@
+{}