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

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index fbf68f854f2f8edf682e8f38cc23f172a6264a75..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
@@ -144,6 +156,8 @@ Here is full list of supported command:
 \r
 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
 \r
+-  ``share 12`` will copy link to tweet with *[id=12]* to your clipboard if you are on a Mac, or display it directly if you are on Linux.\r
+\r
 -  ``del 12`` will delete tweet with *[id=12]*.\r
 \r
 -  ``show image 12`` will show the image in tweet with *[id=12]* in your OS’s image viewer.\r
@@ -218,9 +232,9 @@ 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
+-  ``switch mine`` will switch current stream to personal stream. ``-f`` will work as well.\r
 \r
--  ``switch mine`` will switch current stream to personal stream. ``-f`` and ``-d`` will work as well.\r
+-  ``switch list`` will switch to a Twitter list's stream. You will be asked for list name.\r
 \r
 **Smart shell**\r
 \r
@@ -327,15 +341,17 @@ You also can view or set a new value of every config key by ``config`` command (
 \r
 -  ``THREAD_MIN_WIDTH``: minimum width of a message frame.\r
 \r
+-  ``NOTIFY_FORMAT``: format of a notification.\r
+\r
 -  ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
 \r
 -  ``TREND_MAX``: default trends to display on 'trend' command.\r
 \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
@@ -369,6 +385,9 @@ You also can view or set a new value of every config key by ``config`` command (
     + ``#recipient_name``: Message's recipient name\r
     + ``#recipient_nick``: Message's recipient screen name\r
 \r
+In every format, you can use unicode characters like ``\u2665``.\r
+Mac users also can use emoji characters as well (Ex: ``::zap::``).\r
+See `Emoji cheatsheet`_ for details.\r
 \r
 Development\r
 -----------\r
@@ -397,7 +416,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
@@ -412,4 +430,4 @@ steps
 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
 .. _default config: https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/config\r
-\r
+.. _Emoji cheatsheet: http://www.emoji-cheat-sheet.com/\r