summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2023-08-09 16:30:55 +0200
committerJoas Schilling <coding@schilljs.com>2023-08-10 16:26:06 +0200
commit5e10ea4dce0a9df9a474b661716004fe3ea68f19 (patch)
tree5fb9080dec05e437508021de3fe5b9b081950d8e /docs
parent29445b6a71b4f4a40d7272abaf93700f6ddc5c43 (diff)
feat: Start a list with know bots
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/bot-list.md31
-rw-r--r--docs/botscreenshots/call-summary.pngbin0 -> 65808 bytes
2 files changed, 31 insertions, 0 deletions
diff --git a/docs/bot-list.md b/docs/bot-list.md
new file mode 100644
index 000000000..9961dde5a
--- /dev/null
+++ b/docs/bot-list.md
@@ -0,0 +1,31 @@
+# List of available bots
+
+If you want to write your own bot or webhook, please see the
+[Bots and Webhooks developer documentation](bots.md). Afterwards send a pull
+request against the [docs/bot-list.md](https://github.com/nextcloud/spreed/blob/master/docs/bot-list.md)
+to add your bot to the list, using the following template:
+
+```markdown
+## Name of the bot
+
+Useful, but short description, best to keep it to 1-3 lines of text.
+
+![Screenshot can be put into docs/botscreenshots/bot-name.png, max. width 700px, max. height 480px](botscreenshots/bot-name.png)
+
+* License: Identifier of the license (See https://spdx.org/licenses/)
+* [Link to source code](https://github.com/nextcloud/call_summary_bot)
+* [Link to installation documentation](https://github.com/nextcloud/call_summary_bot#readme)
+```
+
+Here you can find a brief overview of known bots that allows administration to
+easily discover your bot and install it on their Nextcloud server.
+
+## Call summary
+
+The call summary bot posts an overview message after the call listing all participants and outlining tasks.
+
+![Screenshot showing a call summary chat message](botscreenshots/call-summary.png)
+
+* License: AGPL-3.0-or-later
+* [Link to source code](https://github.com/nextcloud/call_summary_bot)
+* [Link to installation documentation](https://github.com/nextcloud/call_summary_bot#readme)
diff --git a/docs/botscreenshots/call-summary.png b/docs/botscreenshots/call-summary.png
new file mode 100644
index 000000000..b0b3cf878
--- /dev/null
+++ b/docs/botscreenshots/call-summary.png
Binary files differ