From 1df1fedbe868eb77c1f4a1b4704dba9d1e5c4f36 Mon Sep 17 00:00:00 2001
From: Kiril Kovachev <ktkovachev@gmail.com>
Date: Mon, 4 Nov 2024 00:17:41 +0000
Subject: [PATCH] Set up project

---
 .gitignore |  3 +++
 README.md  | 10 ++++++++++
 2 files changed, 13 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a35594d
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+.env
+.venv
+__pycache__
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a2691a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Purpose
+This script scrapes the Warwick Accommodation page in order to update you whenever the page changes.
+The page typically says (before it opens) that the applications are not yet open, thus, when this is no longer the case
+(or whenever the page changes at all, for extra caution), the script (the "sniper") can send out a message.
+
+## Usage
+The script is currently quite limited, but you can access it through the `cli_sniper.py` entry point.
+  `python cli_sniper.py`
+
+It will only notify you via a terminal output at this stage. A Discord bot is in the works.
\ No newline at end of file