X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=b68e8c4e01d4056e0edd560c0bf9004c53b7d867;hp=e1449cabf9a705de39c080477f0f109cdd7efe0d;hb=326866703f6fb4222e5d9c8fabce9f28e9e186af;hpb=b8cc314c2a44082c1030a6139dde141f04ce5b43;ds=sidebyside

diff --git a/README.rst b/README.rst
index e1449ca..b68e8c4 100644
--- a/README.rst
+++ b/README.rst
@@ -2,25 +2,27 @@ Rainbow Stream
 --------------
 
 .. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat
-   :target: https://pypi.python.org/pypi/rainbowstream/0.0.3
-   
+   :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/0.0.3
+   :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
+
+Screenshot:
 
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png
-   :alt: v0.0.1
+   :alt: rainbowstream
 
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png
-   :alt: v0.0.3
+   :alt: rainbowstreamIOT
 
 Install
 -------
@@ -29,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
@@ -57,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
@@ -67,73 +78,21 @@ 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**
-
--  ``home`` will show your timeline. ``home 10`` will print exactly 10
-   tweet.
-
--  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
-   exactly 9 tweet.
-
--  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
-   rainbow is god’s promise to noah’*
+For available commands, please `Read The Docs`_.
 
--  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
-   each tweet beside the time.
+For themes and color setting, see `config guide`_.
 
--  ``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.
-
--  ``ls fl`` will list all your followers (people who is following you).
-
--  ``ls fr`` will list all your friends (people who you are following).
-
--  ``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
 -------
 
@@ -142,7 +101,10 @@ 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: #