From ff9f287405eb3453b8f3a537814108673b032737 Mon Sep 17 00:00:00 2001
From: Antoine Martin <antoine97.martin@gmail.com>
Date: Sun, 7 Feb 2021 19:12:00 +0100
Subject: [PATCH] README: setup

---
 README.org | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.org

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..de102ce
--- /dev/null
+++ b/README.org
@@ -0,0 +1,31 @@
+#+title: BadNews: Matrix Bot, Bringer of Bad News
+
+* What is this?
+
+=BadNews= is a [[https://matrix.org][Matrix]] bot, watching your systemd/journald logs, and reporting
+bad news to you.
+
+* Why?
+
+A mix of wanting to toy around with the [[https://github.com/matrix-org/matrix-rust-sdk][matrix_sdk crate]] and getting some
+simple alerts from my hosted services.
+
+* Setup
+
+Write up a configuration file at =config.yaml=:
+
+#+begin_src yaml
+homeserver: "https://matrix.example.net"
+username: "bad-news"
+password: "matrix password for user bad-news"
+state_dir: "state/"
+room_id: "!DeaDbEef:example.net"
+units:
+  - nginx.service
+#+end_src
+
+Then run the bot:
+
+#+begin_src sh
+cargo run -- --config config.yaml
+#+end_src