check semaphore fist on tweet and message

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index 0b85d193310e82bf8023df7e6d1d9fea04fb236c..976461fabc74da9d613af79b29424db9f98b73ce 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -11,13 +11,14 @@ Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
 favorite … and much more fun directly from terminal.\r
 \r
 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, \r
-can run on Python 2.7+ and 3.2+.\r
+can run on Python 2.7.x and 3.x .\r
 \r
 \r
 Showcase\r
-----------\r
-Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
+--------\r
 \r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif\r
+   :alt: gif\r
 \r
 Install\r
 -------\r
@@ -68,6 +69,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 (see `config management`_ section).\r
+\r
 In the first time you will be asked for authorization of Rainbow Stream\r
 app at Twitter. Just click the “Authorize access” button and paste PIN\r
 number to the terminal, the rainbow will start.\r
@@ -86,7 +90,7 @@ suggestion. Input history from previous run is available as well.
 Available commands are listed in `Read The Docs`_.\r
 \r
 Theme customization\r
-------------------------\r
+-------------------\r
 \r
 Rainbow Stream is shipped with some default themes.\r
 You can either change theme by ``theme`` command or create your favorite one.\r
@@ -130,7 +134,7 @@ steps
 \r
 -  `Create your own Twitter Application`_\r
 -  Get your Twitter application’s API key and secret\r
--  Fork github's repo\r
+-  Fork this repo and clone in your system.\r
 -  Create a file ``consumer.py`` in `rainbowstream`_ folder with\r
    following content\r
 \r
@@ -144,11 +148,13 @@ steps
 \r
    .. code:: bash\r
 \r
-       # cd to directory which contains setup.py\r
+       # cd to directory which contains setup.py (cloned directory)\r
        virtualenv venv # Python3 users: use -p to specify python3\r
        source venv/bin/activate\r
        pip install -e .\r
-       pip list | grep rainbowstream # confirm installed version\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
 \r
@@ -176,3 +182,4 @@ details
 .. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
 .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r