HTTP/SOCKS proxy support added (resolves DTVD/rainbowstream#60)

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index 38523bad5fed941c8e756343db02fa82030fe786..b1f6fdb55019a4ced4fb3a15ccd8495c505ef755 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -50,28 +50,29 @@ 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
 \r
     sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev\r
-    sudo pip install rainbowstream\r
 \r
 Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with\r
 the ``Pillow`` package installation - a dependency of this app.\r
-If you are in this case, I recommend take a look at `Issue #10`_ and let me know if this workaround doesn't work for you.\r
+If you are in this case, I recommend taking a look at `Issue #10`_ and let me know if this workaround doesn't work for you.\r
 \r
 .. code:: bash\r
 \r
     export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future\r
-    sudo pip install rainbowstream\r
 \r
-If installation in *the quick way* doesn't work, first try to use the *virtualenv way* before creating an issue.\r
-In the issue, please provide following information:\r
+If installation in *the quick way* doesn't work:\r
 \r
--  Your OS\r
--  Your Python version\r
+-  ``sudo pip uninstall rainbowstream``\r
+-  use the *virtualenv way* above\r
+-  `create an issue`_ and provide:\r
+\r
+  + Your OS\r
+  + Your Python version\r
 \r
 Usage\r
 -----\r
@@ -94,9 +95,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
@@ -104,6 +105,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
@@ -181,7 +194,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