Diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_admin_notify/README.md	Tue Mar 18 00:16:25 2025 +0700
@@ -0,0 +1,28 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: API to notify server admins
+---
+
+# Introduction
+
+This module provides an API for other module developers to send
+notification messages to host admins.
+
+# Configuration
+
+None required.
+
+# Developers
+
+Example:
+
+```
+local notify_admins = module:depends("admin_notify").notify;
+
+notify("This is an important message for you, admins")
+```
+
+# Compatibility
+
+Prosody trunk or later. Incompatible with 0.11 or lower.