doc: Improved documentation

[sid.git] / README.rst

diff --git a/README.rst b/README.rst
index 3bd1ca5bf62c86a276f5b8d2dae3e495f9e75925..1d724e19729a9b63bcc4922bbb0675cc7aff58da 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -5,16 +5,22 @@ sid an xmpp bot
 Getting sid
 ------------
 
-Currently unreleased, only a development version is available.
+Currently unreleased on PyPi_.
+
+`git tagged` version and `master branch` should be stable though.
+
+* Doc:   https://kaliko.gitlab.io/sid/
+* git:   https://gitlab.com/kaliko/sid.git
+* Issue: https://gitlab.com/kaliko/sid/-/issues
 
-* doc: https://kaliko.gitlab.io/sid/
-* git: https://gitlab.com/kaliko/sid.git
-* issue: https://gitlab.com/kaliko/sid/-/issues
 
 Get the source with git::
 
   git clone git://git.kaliko.me/sid.git
 
+Install/update master from git::
+
+  pip install -U git+https://gitlab.com/kaliko/sid.git@master#egg=sid
 
 Using the bot
 -------------
@@ -29,9 +35,12 @@ Here is a plain example::
    from sid.ping import Ping
 
    JID = 'bot@example.org'
+   ROOM = 'room@conf.example.org'
+   # Pay attention: if you join the room with the same account/nick,
+   # For instance with a regular interactive client, the bot will
+   # not answer you, it ignores its own messages for obvious reasons.
    NICK = 'sid'
    PASS = getpass.getpass(f'Password for "{JID}": ')
-   ROOM = 'room@conf.example.org'
 
    # Instanciate the bot
    xmpp = MUCBot(JID, PASS, ROOM, NICK)
@@ -51,3 +60,5 @@ Contacting author
 
 The current maintainer can be found on xmpp chat room <kaliko.me⊘conf.azylum.org>
 or you can contact him by email/xmpp <kaliko⊘azylum.org>.
+
+.. _PyPI: https://pypi.org