X-Git-Url: http://git.kaliko.me/?p=sid.git;a=blobdiff_plain;f=doc%2Fsource%2Frtbl.rst;fp=doc%2Fsource%2Frtbl.rst;h=daa891c9fbd91eb6089f9eba021645642d04e53f;hp=0000000000000000000000000000000000000000;hb=95c99b21c39e37d0f3ca2715642b28af990c379a;hpb=a8273fcb65b081ee9ebda42a0f39f071850d8f66

diff --git a/doc/source/rtbl.rst b/doc/source/rtbl.rst
new file mode 100644
index 0000000..daa891c
--- /dev/null
+++ b/doc/source/rtbl.rst
@@ -0,0 +1,27 @@
+Real time block list
+--------------------
+
+The real time block list plugin can be used easily calling the module:
+
+.. code:: bash
+
+    # Create the virtual env
+    python3 -m venv --prompt "rtbl-bot" venv
+    ./venv/bin/activate
+    pip install -U pip wheel slixmpp==1.8.3
+    # Fetch the code
+    git clone -b dev https://gitlab.com/kaliko/sid.git
+    # Smoke test
+    python3 -m sid.rtbl --help
+
+
+Then run, within the same virtual env:
+
+.. code:: bash
+
+    # Activate the previously created virtual env
+    ./venv/bin/activate
+    # Run the bot
+    python3 -m sid.rtbl --jid botjid@example.org \
+                        --room muc_to_moderate@conf.example.org \
+                        --rtbl xmppbl.org