document
[rainbowstream.git] / README.md
index 63b9704..9e6014e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,39 @@
 ## Rainbow Stream
-Terminal-based Twitter Client. 
+
+[![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 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)
+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/develop/screenshot/RainbowStreamvSS(Image).png)
 
 ## Install
 You will need Python 2.7+ and pip.
 
 ```bash
+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
@@ -22,71 +42,37 @@ rainbow
 ```
 and see your stream.
 
-In the case you want to see photos directly in terminal, the command is 
+I shipped a feature which can display **tweet's images directly on terminal**.
+You can try it with:
 ```bash
-rainbow -img 1 # or rainbow --image 1
+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.
 
-#### 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 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
-
-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```
+## Interactive mode
 
-* ```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'*
-
-* ```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.
-
-* ```fr```will list all friend (You are following people).
-
-* ```fl```will list all follower.
-
-* ```h```will show the help.
+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.
 
-* ```c```will clear the screen.
+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.
 
-* ```q```will quit.
+For available commands, please [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/).
 
-For example see the screenshot above.
+For themes and color setting, see [config guide](#).
 
-## Bug Report
-Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new) 
+## 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