1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..79dce74
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# ssl_expire_notifier
+
+Simple PHP script that checks SSL certificates expiration dates for a list of given domains
+and notifies you via Telegram if some of them are about to expire.
+
+Supposed to be run by cron daily or so.
+
+## Configuration
+
+Config file is expected to be at `~/.config/ssl_expire_notifier.ini`.
+
+```ini
+telegram_enabled = 1
+telegram_token = "your_bot_token"
+telegram_chat_id = "your_chat_id"
+
+verbose = 1
+warn_days = 60
+error_days = 30
+
+hosts[] = example.org
+hosts[] = mail.example.com:993
+```
+
+
+## License
+
+MIT