add repall command

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index 35480342f3fb03e92255507ce638b6fc61a5ddc6..d5b45c0cc6290ee0cacee2c6d8619d1e72fd136a 100644 (file)
--- a/README.rst
+++ b/README.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,9 @@ 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
 Showcase\r
 --------\r
@@ -105,6 +108,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
@@ -182,7 +197,6 @@ steps
        source venv/bin/activate\r
        pip install -e .\r
        which rainbowstream # /this-directory/venv/bin/rainbowstream\r
-       pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
        # Remove ~/.rainbow_oauth if exists\r
        rainbowstream # local version of rainbowstream\r
 \r