From b586b625585b69d7c8638b5900b088caafb70b35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maxime=20=E2=80=9Cpep=E2=80=9D=20Buquet?= Date: Sat, 12 Mar 2022 01:33:28 +0100 Subject: [PATCH] README: mention example bot MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Maxime “pep” Buquet --- README.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.rst b/README.rst index be95aa1..10c38a1 100644 --- a/README.rst +++ b/README.rst @@ -27,6 +27,19 @@ Installation - PIP: `slixmpp-omemo` - Manual: `python3 setup.py install` +Examples +-------- + +The repository contains an example bot that contains many comments, and +can be used to test against other setups. To use it: + +``` +python examples/echo_bot.py --debug -j foo@bar -p passwd --data-dir /foo/bar +``` + +It also contains commands. Feel free to open merge requests or issues to +add new useful ones. + Credits -------