From: kaliko <kaliko@azylum.org>
Date: Wed, 13 May 2020 09:02:07 +0000 (+0200)
Subject: doc: Update README
X-Git-Tag: 0.1.0~3
X-Git-Url: https://git.kaliko.me/?a=commitdiff_plain;h=3f5348e974172a05fc4710b7f3d05963b407627e;p=sid.git

doc: Update README
---

diff --git a/README.rst b/README.rst
index 1449a96..3bd1ca5 100644
--- a/README.rst
+++ b/README.rst
@@ -7,8 +7,9 @@ Getting sid
 
 Currently unreleased, only a development version is available.
 
-* http: https://kaliko.me/sid/
-* git: http://git.kaliko.me/?p=sid.git
+* 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::
 
@@ -29,11 +30,14 @@ Here is a plain example::
 
    JID = 'bot@example.org'
    NICK = 'sid'
-   PASS = getpass.getpass('Password for "{}": '.format(JID))
+   PASS = getpass.getpass(f'Password for "{JID}": ')
    ROOM = 'room@conf.example.org'
 
+   # Instanciate the bot
    xmpp = MUCBot(JID, PASS, ROOM, NICK)
+   # Register a plugin
    xmpp.register_bot_plugin(Ping)
+
    # Connect to the XMPP server and start processing XMPP stanzas.
    try:
        xmpp.connect()