From d4ccf9af7b5d4ce149e2ca36d6ef1b85fc716de4 Mon Sep 17 00:00:00 2001
From: Luna <git@l4.pm>
Date: Mon, 21 Jul 2025 19:02:54 -0300
Subject: [PATCH] add README.md

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f1d781a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# mullvad_check
+
+check if mullvad is close to expiry and emit a discord webhook if so
+
+```
+git clone ... && cd ...
+python3 -m venv env
+env/bin/pip install -Ur requirements.txt
+
+export MULLVAD_ACCOUNT_NUMBER=...
+export MULLVAD_WARNING_DAYS=5 # or 30
+export DISCORD_WEBHOOK_URL=https://discord.com/...
+
+# run this hourly, daily, whatever idc!
+# it stores data on cwd mullvad_cache.json so make sure cwd is writeable
+env/bin/python3 ./mullvad_check.py
+```