bumped version

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index 0a3c376d065ec3e6ee773fe1b78341e88d191c44..1d757886d4d7d40ab909a70ab0d61cfee103d24e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,40 +1,78 @@
 ## Rainbow Stream
-Terminal-based Twitter Client with Streaming API support. Only supports Python 2.7 or later.
 
-This package build on the top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter Streaming API](https://dev.twitter.com/docs/api/streaming) and inspired by [EarthQuake](https://github.com/jugyo/earthquake)
+[![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
+[![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
+
+Terminal-based Twitter Client.
+Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
+
+This package is built on top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter API](https://dev.twitter.com/docs/api/1.1).
+
+## Showcase
+Screencast:
+https://www.youtube.com/watch?v=tykCvPMJq8s
+<br>
+
+Screenshot:
+![rainbowstream](./screenshot/RainbowStream.png)
+![rainbowstreamIOT](./screenshot/RainbowStreamIOT.png)
 
-## Screenshot
-![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
 
 ## Install
-**The easy way:**
-* Clone this repo
-* Create virtualenv (optional but recommended)
-* Install dependencies
-* Install the package itself
+You will need Python 2.7+ and pip.
 
 ```bash
-git clone https://github.com/DTVD/rainbowstream.git
-cd rainbowstream
-virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv"
-source venv/bin/activate
-pip install -e .
+sudo pip install rainbowstream
 ```
-**The quick way:**
-* Install everything over the air
 
+or try with a virtualenv
 ```bash
-sudo pip install git+https://github.com/DTVD/rainbowstream.git
+sudo pip install virtualenv # skip if you already have virtualenv
+virtualenv venv
+source venv/bin/activate # use the brand new virtualenv.
+pip install rainbowstream
 ```
-**Note the I only support Python version 2.7+**
+
 
 ## Usage
+#### The stream
+Just type
 ```bash
-rainbowstream
+rainbow
+```
+and see your stream.
+
+I shipped a feature which can display **tweet's images directly on terminal**.
+You can try it with:
+```bash
+rainbow -iot # Or rainbow --image-on-term
 ```
-In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
 
+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 number to the terminal, the rainbow will start.
 
+## 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 the Enter key to see the help.
+
+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.
+
+Available commands are listed in [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/) 
+while themes and colors setting's can be found at
+[config guide](https://github.com/DTVD/rainbowstream/blob/master/theme.md).
+
+## Bug and feature requests
+Found a bug or a feature request ?
+Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
+or contact me at [@dtvd88](https://twitter.com/dtvd88)
+
+## Contributing
+I appreciate any help and support. Feel free to
+[fork](https://github.com/DTVD/rainbowstream/fork)
+and
+[create a pull request](https://github.com/DTVD/rainbowstream/compare/).
+You will be listed as contributor.
+
 ## License
 Rainbow Stream are released under an MIT License. See LICENSE.txt for details