X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=de88ab0220f6e5649f79b070a533dbc35f319c05;hp=738c1f98a88ef9378946bfe75911fdb8f4bbf09b;hb=b913cd7528810f85f31608f784cba4bfb9477e56;hpb=c1fa7c947ef04c08c5ad03fc21187dc422981b49

diff --git a/README.rst b/README.rst
index 738c1f9..de88ab0 100644
--- a/README.rst
+++ b/README.rst
@@ -1,20 +1,28 @@
 Rainbow Stream
 --------------
 
+.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat
+   :target: https://pypi.python.org/pypi/rainbowstream
+
+.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat
+   :target: https://pypi.python.org/pypi/rainbowstream
+
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
 favorite … and much more fun directly from terminal.
 
-This package build on the top of `Python Twitter Tool`_ and `Twitter
-Streaming API`_ and inspired by `EarthQuake`_
+This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.
 
-Screenshot
+Showcase
 ----------
+Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s
 
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS.png
-   :alt: v0.0.1
+Screenshot:
 
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS(Image).png
-   :alt: v0.0.2
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png
+   :alt: rainbowstream
+
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png
+   :alt: rainbowstreamIOT
 
 Install
 -------
@@ -23,6 +31,15 @@ You will need Python 2.7+ and pip.
 
 .. code:: bash
 
+    sudo pip install rainbowstream
+
+or try with a virtualenv
+
+.. code:: bash
+
+    sudo pip install virtualenv # skip if you already have virtualenv
+    virtualenv venv
+    source venv/bin/activate # use the brand new virtualenv.
     pip install rainbowstream
 
 Usage
@@ -51,7 +68,7 @@ app at Twitter. Just click the “Authorize access” button and paste PIN
 number to the terminal, the rainbow will start.
 
 The interactive mode
-^^^^^^^^^^^^^^^^^^^^
+--------------------
 
 While your personal stream is continued, you are also ready to tweet,
 search, reply, retweet… directly from console. Simply type “h” and hit
@@ -61,69 +78,27 @@ 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.
 
-Here is full list of supported command
-
-**Stream Command**
-
--  ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``
-
--  ``switch public #AKB48 -f`` will do exactly as above but will ask you
-   to provide 2 list:
-
-   ``Only nicks`` decide what nicks will be include only.
-
-   ``Ignore nicks`` decide what nicks will be exclude.
-
--  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and
-   *IGNORE\_LIST*. You can setup 2 list above at ``config.py``
-
--  ``switch mine`` will switch current stream to personal stream. ``-f``
-   and ``-d`` will work as well.
-
-**Action Command**
+Available commands are listed in `Read The Docs`_.
 
--  ``home`` will show your timeline. ``home 10`` will print exactly 10
-   tweet.
+Theme customization
+------------------------
 
--  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
-   exactly 9 tweet.
+Rainbow Stream is shipped with some default themes. 
+You can either change theme by ``theme`` command or create your favorite one.
 
--  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
-   rainbow is god’s promise to noah’*
+For detaile information, see `theme usage and customization`_.
 
--  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
-   each tweet beside the time.
-
--  ``fav 12`` will favorite the tweet with *[id=12]*.
-
--  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
-
--  ``del 12`` will delete tweet with *[id=12]*.
-
--  ``ufav 12`` will unfavorite tweet with *[id=12]*.
-
--  ``s #noah`` will search the word *‘noah’*. Result will come back
-   with highlight.
-
--  ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.
-
--  ``fl @dtvd88`` will follow @dtvd88.
-
--  ``ufl @dtvd88`` will unfollow @dtvd88.
-
--  ``h`` will show the help.
-
--  ``c`` will clear the screen.
-
--  ``q`` will quit.
-
-For example see the screenshot above.
-
-Bug Report
-----------
+Bug and feature requests
+------------------------
 
+Found a bug or a feature request ?
 Please `create an issue`_ or contact me at `@dtvd88`_
 
+Contributing
+------------
+I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
+You will be listed as contributor.
+
 License
 -------
 
@@ -132,7 +107,11 @@ details
 
 
 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
-.. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming
-.. _EarthQuake: https://github.com/jugyo/earthquake
+.. _Twitter API: https://dev.twitter.com/docs/api/1.1
 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
 .. _@dtvd88: https://twitter.com/dtvd88
+.. _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: https://github.com/DTVD/rainbowstream/blob/master/theme.md
+.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md