Fix some bugs by pull requests
[rainbowstream.git] / docs / index.rst
index 76167ed8051e228907120de6ed6ab3954095d79d..93f0399937e80fcf3cca9b396cf563c1551f961b 100644 (file)
@@ -1,10 +1,10 @@
 Rainbow Stream\r
 --------------\r
 \r
-.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
-   :target: https://pypi.python.org/pypi/rainbowstream\r
+.. image:: http://img.shields.io/pypi/l/rainbowstream.svg?style=flat-square\r
+   :target: https://github.com/DTVD/rainbowstream/blob/master/LICENSE.txt\r
 \r
-.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
+.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat-square\r
    :target: https://pypi.python.org/pypi/rainbowstream\r
 \r
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
@@ -13,6 +13,10 @@ favorite … and much more fun directly from terminal.
 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
 can run on Python 2.7.x and 3.x .\r
 \r
+Home page : http://www.rainbowstream.org/\r
+\r
+Source code : https://github.com/DTVD/rainbowstream\r
+\r
 Install\r
 -------\r
 \r
@@ -128,6 +132,8 @@ Here is full list of supported command:
 \r
 -  ``home`` will show your timeline. ``home 10`` will print exactly 10 tweets.\r
 \r
+-  ``me`` will show your latest tweets. ``me 2`` will show your last 2 tweets.\r
+\r
 -  ``notification`` will show your notification from the time you started RainbowStream.\r
 \r
 -  ``mentions`` will show mentions timeline. ``mentions 7`` will show 7 mention tweets.\r
@@ -150,7 +156,9 @@ Here is full list of supported command:
 \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
+-  ``rep 12 Really`` will reply *‘Really’* to the owner of the tweet with *[id=12]*.\r
+\r
+-  ``repall 12 Really`` will reply *‘Really’* to all people in the tweet with *[id=12]*.\r
 \r
 -  ``fav 12`` will favorite the tweet with *[id=12]*.\r
 \r
@@ -313,13 +321,20 @@ You also can view or set a new value of every config key by ``config`` command (
 \r
 -  ``IMAGE_ON_TERM``: display tweet's image directly on terminal.\r
 \r
+-  ``IMAGE_RESIZE_TO_FIT``: display tweet's image fit inside terminal view (width and height).\r
+\r
 -  ``THEME``: current theme.\r
 \r
 -  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
 \r
 -  ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.\r
 \r
--  ``PREFIX``: display string of prompt.\r
+-  ``PREFIX``: display formated string of prompt.\r
+\r
+    + ``#me``: Your username with '@', only available in personal stream.\r
+    + ``#place``: List name, only available in list stream.\r
+    + ``#owner``: Owner of list name, only available in list stream.\r
+    + ``#keyword``: Keyword, only available on public stream.\r
 \r
 -  ``SEARCH_TYPE``: search type in 'search' command ('mixed','recent','popular').\r
 \r