rearrange functions and add docs

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index d32f5102a241bc86e600a4c1d0190310fc914a30..56b97a5b6490983f3292acba2d7dd244fa60235d 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -42,7 +42,7 @@ Use `virtualenv`_
 Troubleshooting\r
 ^^^^^^^^^^^^^^^\r
 \r
-If you use Linux, you might need to install some packages if you haven't already. \r
+If you use Linux, you might need to install some packages if you haven't already.\r
 For debian-based distros, these can be installed with\r
 \r
 .. code:: bash\r
@@ -87,9 +87,9 @@ You can try it with:
 \r
     rainbowstream -iot # Or rainbowstream --image-on-term\r
 \r
-You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app \r
-to enable above feature, \r
-change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width) \r
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app\r
+to enable above feature,\r
+change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width)\r
 or ``IMAGE_MAX_HEIGHT`` to control max height of every image.\r
 (see `config management`_ section).\r
 \r
@@ -143,6 +143,8 @@ Here is full list of supported command:
 \r
 -  ``allrt 12 20`` will list 20 newest retweets of the tweet with *[id=12]*. If the number of retweets is not specified, 5 newest retweets will be listed instead.\r
 \r
+-  ``conversation 12`` will show the chain of replies prior to the tweet with *[id=12]*.\r
+\r
 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
 \r
 -  ``fav 12`` will favorite the tweet with *[id=12]*.\r
@@ -324,6 +326,8 @@ You can view or set a new value of every config key by ``config`` command (See *
 \r
 -  ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
 \r
+-  ``CONVERSATION_MAX``: max tweet in a 'conversation' thread.\r
+\r
 -  ``QUOTE_FORMAT``: format when quote a tweet\r
 \r
     + ``#comment``: Your own comment about the tweet\r