From e0ff0ee72a7dacdb3a3f37f047e5edf58809d427 Mon Sep 17 00:00:00 2001 From: manetta Date: Mon, 1 Feb 2021 11:14:57 +0100 Subject: [PATCH] syncing the help text with the readme file --- LogBot/README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/LogBot/README.md b/LogBot/README.md index b44593c..6d7d99e 100644 --- a/LogBot/README.md +++ b/LogBot/README.md @@ -2,20 +2,25 @@ A small XMPP bot written in Python that logs XMPP conversations into a HTML page, allowing collaborative log writing over time. -The bot is used in group chats, where it includes all images that are send to the group and all messages that include `@logbot`. +The bot is used in group chats, where it includes all images that are send to the group and all messages that include `@logbot` or `logbot` or `logbot:`. *work-in-progress* ## How to use LogBot? +``` *Oh dear, logbot is here!* -* `@logbot`: send a message to the groupchat with `@logbot` and it will add the whole message to the log -* send an image to the groupchat, it will add it to the log -* `@delete ` Delete posts from the log. For example: @logbot @delete 5 -* `@bots`: To see who is around :) -* `@uptime`: To check how long @logbot has been around -* `@help`: Print this message +(You can speak to the bot using @logbot or logbot:) +: Your image is added to the log. +logbot @help: Print this message +logbot @add : Add a message to the log. +logbot @delete : Delete posts from the log. For example: @logbot @delete 5 +logbot @title : Set the title of your log. +logbot @style : Edit the css of your log. For example: logbot @style body background-color: pink; [future-feature] +logbot @uptime: To check how long @logbot has been around +@bots: To see who is around :) +``` ## Situated tails @@ -25,4 +30,4 @@ The bot is used in group chats, where it includes all images that are send to th ## Requirements -* [xbotlib](https://git.vvvvvvaria.org/decentral1se/xbotlib) \ No newline at end of file +* [xbotlib](https://git.vvvvvvaria.org/decentral1se/xbotlib)