autopep8 and bumped version
[rainbowstream.git] / README.rst
index ee15eb5..6ec76fe 100644 (file)
@@ -10,13 +10,19 @@ Rainbow Stream
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
 favorite … and much more fun directly from terminal.\r
 \r
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
 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
+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
 \r
 Showcase\r
 ----------\r
 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
 \r
 \r
 Showcase\r
 ----------\r
 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
 \r
+Screenshot: (click to see)\r
 \r
 \r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png\r
+   :alt: all\r
+   \r
 Install\r
 -------\r
 \r
 Install\r
 -------\r
 \r
@@ -128,8 +134,8 @@ steps
 \r
 -  `Create your own Twitter Application`_\r
 -  Get your Twitter application’s API key and secret\r
 \r
 -  `Create your own Twitter Application`_\r
 -  Get your Twitter application’s API key and secret\r
--  Fork github's repo\r
--  Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
+-  Fork this repo and clone in your system.\r
+-  Create a file ``consumer.py`` in `rainbowstream`_ folder with\r
    following content\r
 \r
    .. code:: python\r
    following content\r
 \r
    .. code:: python\r
@@ -142,11 +148,13 @@ steps
 \r
    .. code:: bash\r
 \r
 \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
        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
        rainbowstream # local version of rainbowstream\r
 \r
 \r
@@ -172,5 +180,5 @@ details
 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
-.. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
+.. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r