Merge pull request #66 from rc0r/master

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 0e9dfea9ee6a23626876dd852816ef9af4b69c6c..cb7da71d7d9239c1606145f2c57f9f687b099503 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -97,6 +97,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
@@ -220,9 +232,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
@@ -339,9 +349,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