From 883935d643d52c228c8f7d3bb9fdc0aaa60a4040 Mon Sep 17 00:00:00 2001 From: spla Date: Tue, 9 Aug 2022 08:14:36 +0200 Subject: [PATCH] Updated --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 37b0d62..e31484c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # xmpp Akkoma bot -bot to manage an xmpp ejabberd node by posting keywords to it from your Akkoma account. +Bot to manage a xmpp ejabberd node from an Akkoma instance, by posting keywords to it. The bot only listen keywords from your Akkoma instance local users. They can register themselves to your ejabberd xmpp server, unregister or also get your xmpp node stats. -The keywords that your Akkoma instance local users can issue against the bot are the following: +The keywords that they can issue against the bot are the following: @your_bot register @your_bot unregister @@ -16,6 +16,11 @@ The bot will process any of the above keywords thanks to the wrapper for ejabber - admin_pass: ejabberd admin account password - Akkoma hostname: in ex. akkoma.host +# Requirements + +- Akkoma instance +- xmpp ejabberd node with admin privileges + Before running `python xmpp.py`: 1. git clone https://git.mastodont.cat/spla/xmpp.git target_dir.