X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.md;h=565558cf7b28cb95a06fdd2feca75e50639fcdc2;hp=26d371f2a3d72c9c78cbbff4533a764806d976c4;hb=37ae740ef2ad0b2a7f2af68d9116c1bc268cbe00;hpb=13e71acbdb289e5466cc805cdda6fa82ff1561ca

diff --git a/README.md b/README.md
index 26d371f..565558c 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,39 @@
-## Rainbow Stream 
+## Rainbow Stream
 
 [![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. 
+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](./screenshot/RainbowStream.png)
-![v0.0.3](./screenshot/RainbowStreamIOT.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
@@ -44,76 +59,114 @@ Input is in interactive mode. It means that you can use arrow key to move up and
 
 Here is full list of supported command
 
-__Action Commands__
+__Explore Commands__
+
+* `trend` will show global trending topics. `trend US` will show trends in United States while `trend JP Tokyo` will show trends in Tokyo/Japan.
+
+* `home` will show your timeline. `home 10` will print exactly 10 tweets.
+
+* `mentions` will show mentions timeline. `mentions 7` will show 7 mention tweets.
+
+* `whois @dtvd88` will show profile of @dtvd88.
 
-* ```trend```will show global trending topics. ```trend US``` will show trends in United States while ```trend JP Tokyo``` will show trends in Tokyo/Japan.
+* `view @mdo` will show @mdo 's timeline. `view @dmo 9` will print exactly 9 tweets.
 
-* ```home```will show your timeline. ```home 10``` will print exactly 10 tweets.
+* `s #noah` will search the word *'noah'*. Result will come back with highlight.
 
-* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweets.
+__Tweet Commands__
 
-* ```mentions```will show mentions timeline. ```mentions 7``` will show 7 mention tweets.
+* `t the rainbow is god's promise to noah` will tweet exactly *'the rainbow is god's promise to noah'*.
 
-* ```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.
+ 
+* `allrt 12 20` will list 20 newest retweets of the tweet with *[id=12]*. 
+If the number of retweets is not specified, 5 newest retweets will be listed instead.
 
-* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
+* `rep 12 Really` will reply *'Really'* to the tweet with *[id=12]*.
 
-* ```fav 12```will favorite the tweet with *[id=12]*.
+* `fav 12` will favorite the tweet with *[id=12]*.
 
-* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
+* `ufav 12` will unfavorite tweet with *[id=12]*.
 
-* ```del 12```will delete tweet with *[id=12]*.
+* `del 12` will delete tweet with *[id=12]*.
 
-* ```ufav 12```will unfavorite tweet with *[id=12]*.
+* `show image 12` will show the image in tweet with *[id=12]* in your OS's image viewer.
 
-* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
+__Direct Messages Commands__
 
-* ```mes @dtvd88 hi```will send a ```hi``` message to @dtvd88.
+* `inbox` will show inbox messages. `inbox 7` will show newest 7 messages.
 
-* ```show image 12``` will show the image in tweet with *[id=12]* in your OS's image viewer.
+* `sent` will show sent messages. `sent 7` will show newest 7 messages.
 
-* ```ls fl```will list all your followers (people who are following you).
+* `mes @dtvd88 hi` will send a `hi` message to @dtvd88.
 
-* ```ls fr```will list all your friends (people who you are following).
+* `trash 5` will remove message with *[message_id=5]*
 
-* ```inbox```will show inbox messages. ```inbox 7``` will show newest 7 messages.
+__Friends and followers Commands__
 
-* ```sent```will show sent messages. ```sent 7``` will show newest 7 messages.
+* `ls fl` will list all your followers (people who are following you).
 
-* ```trash 5```will remove message with *[message_id=5]*
+* `ls fr` will list all your friends (people who you are following).
 
-* ```whois @dtvd88```will show profile of @dtvd88.
+* `fl @dtvd88` will follow @dtvd88.
 
-* ```fl @dtvd88```will follow @dtvd88.
+* `ufl @dtvd88` will unfollow @dtvd88.
 
-* ```ufl @dtvd88```will unfollow @dtvd88.
+* `mute @dtvd88` will mute @dtvd88.
 
-* ```h```will show the help.
+* `unmute @dtvd88` will unmute @dtvd88.
 
-* ```c```will clear the screen.
+* `muting` will list muting users.
 
-* ```q```will quit.
+* `block @dtvd88` will block @dtvd88.
 
-__Stream Commands__
+* `unblock @dtvd88` will unblock @dtvd88.
 
-* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
+* `report @dtvd88` will report @dtvd88 as a spam account.
 
-* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
+__Switching Stream Commands__
 
-    ```Only nicks``` decide what nicks will be include only.
+* `switch public #AKB48` will switch current stream to public stream and track keyword `AKB48`
 
-    ```Ignore nicks```decide what nicks will be exclude.
+* `switch public #AKB48 -f ` will do exactly as above but will ask you to provide 2 list:
 
-* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
-You can setup 2 list above at ```config.py```
+    `Only nicks` decide what nicks will be include only.
 
-* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
+    `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.
+
+__Smart shell__
+
+* Put anything to terminal, the app will try to eval and display result as a python interactive shell.
+  * `142857*2` or `101**3` like a calculator.
+  * Even `cal` will show the calendar for current month.
+  * Put `order_rainbow('anything')` or `random_rainbow('wahahaha')` will make more fun :)
+
+__Screening Commands__
+
+* `h` will show the help.
+
+* `c` will clear the screen.
+
+* `q` will quit.
 
 For example see the screenshot above.
 
-## 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