From 5ab7074d9a884b93726d797ed32fc192c383acc4 Mon Sep 17 00:00:00 2001
From: Laura Nguyen <l69nguye@csclub.uwaterloo.ca>
Date: Mon, 16 Aug 2021 18:25:25 -0400
Subject: [PATCH] Changed README to Markdown and added some information to it

---
 README.md  | 13 +++++++++++++
 README.txt |  5 -----
 2 files changed, 13 insertions(+), 5 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.txt

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..52ae476
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Mirror Checker
+
+This mirror status checker determines whether CSC mirror is up-to-date with upstream.
+
+## How To Run
+
+Run `main.py`.
+
+## Resources
+
+- [CSC Mirror](http://mirror.csclub.uwaterloo.ca/)
+- [Debian Mirror Status Checker](https://mirror-master.debian.org/status/mirror-status.html)
+- [Debian Mirror Status Checker Code](https://salsa.debian.org/mirror-team/mirror/status)
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 0ec7348..0000000
--- a/README.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-
-Resources:
-http://mirror.csclub.uwaterloo.ca/
-https://mirror-master.debian.org/status/mirror-status.html
-https://salsa.debian.org/mirror-team/mirror/status
\ No newline at end of file