From 2524535a10c9ab62e34cd9b3516ac43d1d3849fe Mon Sep 17 00:00:00 2001
From: BroodjeAap <david@broodjeaap.net>
Date: Wed, 28 Dec 2022 13:23:41 +0000
Subject: [PATCH] changed readme for new refactored notifiers

---
 README.md | 24 +++++++++++++++++++-----
 todo.md   |  2 --
 2 files changed, 19 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 21c25cf..60d544a 100644
--- a/README.md
+++ b/README.md
@@ -273,13 +273,24 @@ The gopher-lua-libs provide an [http](https://github.com/vadv/gopher-lua-libs/tr
 
 # Notifiers
 
+The basic form is:  
+```
+notifiers:
+  <notifier-name>:
+    type: "<notifier-type>"
+    other: ""
+    values: ""
+    etc: ""
+```
+See below for possible types.
 ## Shoutrrr
 
 [Shoutrrr](https://containrrr.dev/shoutrrr/v0.5/) can be used to notify many different services, check their docs for a [list](https://containrrr.dev/shoutrrr/v0.5/services/overview/) of which ones.  
 An example config for sending notifications through Shoutrrr:   
 ```
 notifiers:
-  shoutrrr:
+  Shoutrrr-telegram-discord:
+    type: "shoutrrr"
     urls:
     - telegram://<token>@telegram?chats=<channel-1-id>,<chat-2-id>
     - discord://<token>@<webhookid>
@@ -295,7 +306,7 @@ Get a bot token from the [@BotFather](https://core.telegram.org/bots/tutorial) a
 An example config for sending notifications through Telegram:  
 ```
 notifiers:
-  telegram:
+  Telegram:
     token: "<token>"
     chat: "<chatID>"
     debug: false
@@ -311,7 +322,8 @@ Then you can right click on your username in any chat to copy your user ID or ri
 An example config for sending DM notifications through Discord:  
 ```
 notifiers:
-  discord:
+  Discord:
+    type: "discord"
     token: "<token>"
     userID: "<userID>"
     debug: false
@@ -323,7 +335,8 @@ database:
 An example config for sending channel notifications:  
 ```
 notifiers:
-  discord:
+  Discord:
+    type: "discord"
     token: "<token>"
     server:
       ID: "<serverID>"
@@ -341,7 +354,8 @@ Both a userID and serverID/channelID is also possible.
 An example config for sending email notifications through a SMTP relay server:  
 ```
 notifiers:
-  email:
+  Email-to-at-email-com:
+    type: "email"
     server: "smtp.relay.com"
     port: "465"
     from: "from@email.com"
diff --git a/todo.md b/todo.md
index d56f2fe..c85230d 100644
--- a/todo.md
+++ b/todo.md
@@ -4,6 +4,4 @@
 - comments
 - run/fix staticcheck
 - add browserless support ?
-- ~~refactor notifiers to be a list, with 'type' value?~~
-    - readme
 - file output notifier?
\ No newline at end of file