README

[systemd-monitor] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..3ef9700
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# systemd-monitor
+
+Monitor systemd state and email root if there is a problem.
+
+## Usage
+
+- Run `makepkg` for Arch Linux or `./makedeb` for Debian/Ubuntu. Install the resulting package.
+- Configure an MTA so you can receive mail sent with the command: `echo foobody | mail -s foosubject root`
+- Enable and start the service: `systemctl enable systemd-monitor && systemctl start systemd-monitor`