From b7a0f69511c340f745800d25b1f9fc4881a3e8fa Mon Sep 17 00:00:00 2001
From: alex <alex@roese.dev>
Date: Thu, 30 Jun 2022 19:13:21 +0200
Subject: [PATCH] added readme

---
 matrix-bot/matrix-bot.go | 1 -
 readme.md                | 4 ++++
 2 files changed, 4 insertions(+), 1 deletion(-)
 create mode 100644 readme.md

diff --git a/matrix-bot/matrix-bot.go b/matrix-bot/matrix-bot.go
index 6e5c2f4..24facf8 100755
--- a/matrix-bot/matrix-bot.go
+++ b/matrix-bot/matrix-bot.go
@@ -22,7 +22,6 @@ type Representation struct {
 	Note           string `json:"note"`
 }
 
-// day string, hour string, class string, representative string, teacher string, subject string, room string, note string
 func SendMessage(today string, nextDay string) {
 	cfg := config.Cfg.Bot
 
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..b7d0fed
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,4 @@
+# Matrix Chat Bot for School portal substitution plan
+
+1. Change `config.sample.yaml` to `config.yaml`
+2. Fill **config.yaml** with your **credentials**
\ No newline at end of file