Merge pull request #156 from Azy8BsKXVko/fix_muting

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 0e9dfea9ee6a23626876dd852816ef9af4b69c6c..348d1a1566c178b4381cbbaa5d814b4e020928ea 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -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
@@ -97,6 +101,18 @@ In the first time you will be asked for authorization of Rainbow Stream
 app at Twitter. Just click the “Authorize access” button and paste PIN\r
 number to the terminal, the rainbow will start.\r
 \r
+You might want to use rainbowstream via an **HTTP/SOCKS proxy**. Proxy settings are\r
+provided as follows:\r
+\r
+.. code:: bash\r
+\r
+    rainbowstream --proxy-host localhost --proxy-port 1337 --proxy-type HTTP\r
+    # or using the short form:\r
+    rainbowstream -ph localhost -pp 1337 -pt HTTP\r
+\r
+Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default\r
+proxy port ``8080`` and default proxy type ``SOCKS5`` are used.\r
+\r
 The interactive mode\r
 ^^^^^^^^^^^^^^^^^^^^\r
 \r
@@ -138,7 +154,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
@@ -220,9 +238,7 @@ Here is full list of supported command:
 \r
    ``Ignore nicks``\ decide what nicks will be exclude.\r
 \r
--  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
-\r
--  ``switch mine`` will switch current stream to personal stream. ``-f`` and ``-d`` will work as well.\r
+-  ``switch mine`` will switch current stream to personal stream. ``-f`` will work as well.\r
 \r
 -  ``switch list`` will switch to a Twitter list's stream. You will be asked for list name.\r
 \r
@@ -258,6 +274,8 @@ Here is full list of supported command:
 \r
 -  ``c`` will clear the screen.\r
 \r
+-  ``v`` will show version info.\r
+\r
 -  ``q`` will quit.\r
 \r
 Theme customization\r
@@ -301,13 +319,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
@@ -339,9 +364,9 @@ You also can view or set a new value of every config key by ``config`` command (
 \r
 -  ``LIST_MAX``: default tweets to display on 'list home' command.\r
 \r
--  ``ONLY_LIST``: filter list on 'switch' command.\r
+-  ``ONLY_LIST``: filter list on 'switch' command. Eg: ["@fat","mdo"]\r
 \r
--  ``IGNORE_LIST``: ignore list on 'switch' command.\r
+-  ``IGNORE_LIST``: ignore list on 'switch' command. Eg: ["@fat"]\r
 \r
 -  ``HISTORY_FILENAME``: name of file which stores input history.\r
 \r
@@ -349,6 +374,8 @@ You also can view or set a new value of every config key by ``config`` command (
 \r
 -  ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.\r
 \r
+-  ``STREAM_DELAY``: seconds to wait before displaying another tweet, will drop all tweets while waiting. This value can be used to slow down the stream.\r
+\r
 -  ``USER_DOMAIN``: user URL of Twitter Streaming API.\r
 \r
 -  ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.\r