document
[rainbowstream.git] / README.md
index 1102f1c..9e6014e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,78 @@
 ## Rainbow Stream
 
-A rainbow stream console for Twitter.
-Base on Python Twitter Tool
+[![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)
+
 
 ## Install
-With python 2.7+ You can:
+You will need Python 2.7+ and pip.
+
 ```bash
-git clone
-pip install requirements.txt
-pip install -e .
+sudo pip install rainbowstream
 ```
 
+or try with a virtualenv
+```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
+#### The stream
+Just type
 ```bash
-rainbowstream
+rainbow
 ```
+and see your stream.
 
-## Screenshot
+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.
+Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
 
-## License
+## 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.
 
-Rainbow Stream are released under an MIT License.
+For available commands, please [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/).
+
+For themes and color setting, see [config guide](#).
+
+## 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