From c121d158facef9d7d50237b2df92c496ffd8a8b4 Mon Sep 17 00:00:00 2001
From: PersnicketyChkn <chrisajohnson234@gmail.com>
Date: Wed, 1 Apr 2026 13:55:44 -0700
Subject: [PATCH] Add initial README with project overview and data model

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

diff --git a/README.md b/README.md
index e69de29..98b684f 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,57 @@
+# Campus Resource
+
+A Website to Manage, Book, and Schedule Resources for Students
+
+## Data Model
+
+```mermaid
+
+classDiagram
+
+Resource <-- Reservation
+Student <-- Reservation
+User <|-- Admin
+User <|-- Student
+  
+class User{
+    - id: int
+    - username: string
+    - email: string
+    - password_hash: string
+    - register(username: string, email: string, password: string) User
+    - login(username: string, password: string) boolean
+}
+
+class Resource{
+  - resourceName: string
+  - availability: bool
+  - id: int
+  - description: string
+  - location: string
+  - category: string
+  - created_at: datetime
+  + register(resourceName: string, location: string, : string)
+}
+
+  class Admin{
+    + addResource()
+    + removeResource()
+    + editResource()
+    + bookStudent(studentId, resource, time)
+    + removeBooking(resource, time)
+  }
+
+class Reservation{
+	- id: int
+	- resource: Resource
+	- student: Student
+	- start_time: datetime
+	- end_time: datetime
+  + viewReservation()
+}
+
+class Student{
+    + reserve(Resource, time: datetime)
+    + cancel(Reservation)
+}
+```