From abb8e6531d7be9f1998295ed3028af3cd4a05ac9 Mon Sep 17 00:00:00 2001
From: Visakh <92223768+vskvj3@users.noreply.github.com>
Date: Thu, 29 Dec 2022 21:52:43 +0530
Subject: [PATCH] added proper readme

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index 862aa5a..b3ecfd8 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,28 @@
 # hostel-management-system
+This project was made as part of KTU Database Management Systems Lab - (CSL333)
+
+---
+## Dependencies
+* [JDK 19](https://www.oracle.com/in/java/technologies/downloads/)  
+* [Mysql](https://www.mysql.com/downloads/) 
+
+## Installation
+1. Download the files
+
+2. create the sql user and data base
+```sql
+source /path/to/initialize.sql
+```
+3. (optional) Create the dummy data
+```sql
+source /path/to/dump.sql
+```
+4. run the jar file
+```bash
+java -jar /path/to/jarfile.jar
+```
+## Tools used :
+* [MYSQL Community Server](https://www.mysql.com/)  
+* [Apache Netbeans 16](https://netbeans.apache.org/)  
+* [JDK 19](https://www.oracle.com/java/technologies/javase/jdk19-archive-downloads.html)  
+* [Mysql-Java Connectivity Driver](https://dev.mysql.com/downloads/connector/j/)