add README.md

This commit is contained in:
Luna 2025-07-21 19:02:54 -03:00
parent b93e6ce0d6
commit d4ccf9af7b

17
README.md Normal file
View file

@ -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
```