From 343978870774f81ecaa06d7f253020265f601fd2 Mon Sep 17 00:00:00 2001
From: Yuren Hao <97327730+YurenHao0426@users.noreply.github.com>
Date: Wed, 6 Aug 2025 01:39:08 -0700
Subject: feat: scaffold prereq graph project

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index b53373d..22b6bb9 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,23 @@
-# uiuc-course-graph
\ No newline at end of file
+# UIUC Course Graph
+
+Static UIUC course prerequisite graph powered by React and Cytoscape.js. Course data is fetched from the UIUC Course Explorer API during build time because the API does not allow cross-origin requests.
+
+## CORS check
+
+```
+$ curl -sD - -o /dev/null https://courses.illinois.edu/cisapp/explorer/schedule/2025/fall.xml
+HTTP/1.1 200 OK
+content-type: application/xml;charset=UTF-8
+server: envoy
+# (no Access-Control-Allow-Origin header)
+```
+
+## Development
+
+```bash
+npm install
+npm run scrape   # generate data/catalog_2025_fall.json
+npm run dev      # start Vite dev server
+```
+
+The GitHub Actions workflow `update-and-deploy.yml` refreshes the catalog daily and deploys the built site to GitHub Pages.
-- 
cgit v1.2.3