X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=976461fabc74da9d613af79b29424db9f98b73ce;hp=982eed9a5c09f3f28ff0fdba695961801ab0cfe0;hb=0d9977c739e5e448af4b49332bd6df1aa9edafc3;hpb=670e804965c17771820b1a6ccbed8d0bda8db993

diff --git a/README.rst b/README.rst
index 982eed9..976461f 100644
--- a/README.rst
+++ b/README.rst
@@ -10,38 +10,44 @@ Rainbow Stream
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
 favorite … and much more fun directly from terminal.
 
-This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.
+This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, 
+can run on Python 2.7.x and 3.x .
 
-Showcase
-----------
-Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s 
-
-Screenshot: 
 
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png
-   :alt: rainbowstream
+Showcase
+--------
 
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png
-   :alt: rainbowstreamIOT
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif
+   :alt: gif
 
 Install
 -------
 
-You will need Python 2.7+ and pip.
+The quick way
+^^^^^^^^^^^^^
+
+You will need Python and pip (2.7.x or 3.x).
 
 .. code:: bash
 
     sudo pip install rainbowstream
-    
-or try with a virtualenv
+    # Python 3 users: sudo pip3 install rainbowstream
+
+
+The recommended way
+^^^^^^^^^^^^^^^^^^^
+
+Use `virtualenv`_
 
 .. code:: bash
 
-    sudo pip install virtualenv # skip if you already have virtualenv
-    virtualenv venv 
-    source venv/bin/activate # use the brand new virtualenv.
+    virtualenv venv
+    # Python 3 users : use -p to specify your Python 3 localtion as below
+    # virtualenv -p /usr/bin/python3 venv
+    source venv/bin/activate
     pip install rainbowstream
 
+
 Usage
 -----
 
@@ -52,7 +58,7 @@ Just type
 
 .. code:: bash
 
-    rainbow
+    rainbowstream
 
 and see your stream.
 
@@ -61,7 +67,10 @@ You can try it with:
 
 .. code:: bash
 
-    rainbow -iot # Or rainbow --image-on-term
+    rainbowstream -iot # Or rainbowstream --image-on-term
+
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app 
+to enable above feature (see `config management`_ section).
 
 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
@@ -78,16 +87,77 @@ Input is in interactive mode. It means that you can use arrow key to
 move up and down history, tab-autocomplete or 2 tab to view available
 suggestion. Input history from previous run is available as well.
 
-For available commands, please `Read The Docs`_.
+Available commands are listed in `Read The Docs`_.
+
+Theme customization
+-------------------
+
+Rainbow Stream is shipped with some default themes.
+You can either change theme by ``theme`` command or create your favorite one.
+
+Theme’s screenshot:
+
+- Monokai
+
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
+   :alt: monokai
+
+- Solarized
 
-For themes and color setting, see `config guide`_.
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
+   :alt: solarized
+
+- Tomorrow Night
+
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
+   :alt: tomorrownight
+
+- Larapaste
+
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
+   :alt: larapaste
+
+
+For detaile information, see `theme usage and customization`_.
 
 Bug and feature requests
 ------------------------
 
-Found a bug or a feature request ? 
+Found a bug or a feature request ?
 Please `create an issue`_ or contact me at `@dtvd88`_
 
+Development
+-----------
+
+If you want to build a runnable version yourself, follow these simple
+steps
+
+-  `Create your own Twitter Application`_
+-  Get your Twitter application’s API key and secret
+-  Fork this repo and clone in your system.
+-  Create a file ``consumer.py`` in `rainbowstream`_ folder with
+   following content
+
+   .. code:: python
+
+       # Consumer information
+       CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
+       CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
+
+-  Use pip to install in local
+
+   .. code:: bash
+
+       # cd to directory which contains setup.py (cloned directory)
+       virtualenv venv # Python3 users: use -p to specify python3
+       source venv/bin/activate
+       pip install -e .
+       which rainbowstream # /this-directory/venv/bin/rainbowstream
+       pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
+       # Remove ~/.rainbow_oauth if exists
+       rainbowstream # local version of rainbowstream
+
+
 Contributing
 ------------
 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
@@ -107,4 +177,9 @@ details
 .. _fork: https://github.com/DTVD/rainbowstream/fork
 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/
 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/
-.. _config guide: #
+.. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md
+.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
+.. _Create your own Twitter Application: https://apps.twitter.com/app/new
+.. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
+.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode