From 397aa68ae9b99d79637a0f033058364a8b4f6006 Mon Sep 17 00:00:00 2001
From: Mann Patel <130435633+MannPatel0@users.noreply.github.com>
Date: Sun, 16 Feb 2025 10:17:17 -0700
Subject: [PATCH] updated the readme

---
 SerialToSerialBT.ino => DisplayConnection.ino |  0
 test.py => Display_API.py                     |  0
 README.md                                     | 54 +++++++++++++++++--
 3 files changed, 51 insertions(+), 3 deletions(-)
 rename SerialToSerialBT.ino => DisplayConnection.ino (100%)
 rename test.py => Display_API.py (100%)

diff --git a/SerialToSerialBT.ino b/DisplayConnection.ino
similarity index 100%
rename from SerialToSerialBT.ino
rename to DisplayConnection.ino
diff --git a/test.py b/Display_API.py
similarity index 100%
rename from test.py
rename to Display_API.py
diff --git a/README.md b/README.md
index 907ceba..cfe8947 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,51 @@
-# CalgaryHacks25
- 
-cFlO2BzSuON1qYWc
\ No newline at end of file
+# Fin Track
+
+## Introduction
+Fin Track is a financial tracking application that helps users stay on top of their banking information at a glance. With a physical display showing real-time bank status, balance, transactions, and savings, users can keep their finances always visible. Additionally, the app allows users to set reminders for recurring payments and engage in interactive quizzes to enhance their financial literacy.
+
+## How to Run
+
+### 1. Clone the Repository
+```bash
+git clone https://github.com/yourusername/fin-track.git
+cd fin-track
+```
+
+### 2. Backend Setup
+1. Navigate to the backend folder:
+   ```bash
+   cd backend
+   ```
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Run the backend server:
+   ```bash
+   node index.js
+   ```
+
+### 3. Frontend Setup
+1. Navigate to the frontend folder:
+   ```bash
+   cd frontend
+   ```
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Run the frontend:
+   ```bash
+   npm run dev
+   ```
+
+### 4. Setting Up the Physical Display (Arduino)
+1. Connect your Arduino to your computer.
+2. Open `fintrack_display.ino` in Arduino IDE.
+3. Upload the script to the Arduino board.
+4. Ensure the board is communicating properly via serial port.
+5. Run the display API:
+   ```bash
+   python3 Display_API.py
+   ```
+