Update README.rst

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index dc720d083e23a0fb5aba641645ed4d02d711112e..bea6ebc17399eca42eb3ba038bdd2e6f64ad9f47 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,16 +1,22 @@
-## Rainbow Stream 
+## Rainbow Stream

 
 

-[![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream/0.0.3)
-[![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream/0.0.3)
+[![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.
 
 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.
 
 ## Install
 You will need Python 2.7+ and pip.


@@ -44,61 +50,111 @@ Input is in interactive mode. It means that you can use arrow key to move up and
 
 Here is full list of supported command
 
 
 Here is full list of supported command
 

-__Stream Command__
-* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
+__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.
+
+* `view @mdo` will show @mdo 's timeline. `view @dmo 9` will print exactly 9 tweets.
+
+* `s #noah` will search the word *'noah'*. Result will come back with highlight.
+
+__Tweet Commands__
+
+* `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.
+
+* `rep 12 Really` will reply *'Really'* to the tweet with *[id=12]*.

 
 

-* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
+* `fav 12` will favorite the tweet with *[id=12]*.

 
 

-    ```Only nicks``` decide what nicks will be include only.
+* `ufav 12` will unfavorite tweet with *[id=12]*.

 
 

-    ```Ignore nicks```decide what nicks will be exclude.
+* `del 12` will delete tweet with *[id=12]*.

 
 

-* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
-You can setup 2 list above at ```config.py```
+* `show image 12` will show the image in tweet with *[id=12]* in your OS's image viewer.

 
 

-* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
+__Direct Messages Commands__

 
 

-__Action Command__
+* `inbox` will show inbox messages. `inbox 7` will show newest 7 messages.

 
 

-* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
+* `sent` will show sent messages. `sent 7` will show newest 7 messages.

 
 

-* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
+* `mes @dtvd88 hi` will send a `hi` message to @dtvd88.

 
 

-* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
+* `trash 5` will remove message with *[message_id=5]*

 
 

-* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
+__Friends and followers Commands__

 
 

-* ```fav 12```will favorite the tweet with *[id=12]*.
+* `ls fl` will list all your followers (people who are following you).

 
 

-* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
+* `ls fr` will list all your friends (people who you are following).

 
 

-* ```del 12```will delete tweet with *[id=12]*.
+* `fl @dtvd88` will follow @dtvd88.

 
 

-* ```ufav 12```will unfavorite tweet with *[id=12]*.
+* `ufl @dtvd88` will unfollow @dtvd88.

 
 

-* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
+* `mute @dtvd88` will mute @dtvd88.

 
 

-* ```show image 12``` will show the image in tweet with *[id=12]* in your OS's image viewer.
+* `unmute @dtvd88` will unmute @dtvd88.

 
 

-* ```ls fl```will list all your followers (people who is following you).
+* `muting` will list muting users.

 
 

-* ```ls fr```will list all your friends (people who you are following).
+* `block @dtvd88` will block @dtvd88.

 
 

-* ```fl @dtvd88```will follow @dtvd88.
+* `unblock @dtvd88` will unblock @dtvd88.

 
 

-* ```ufl @dtvd88```will unfollow @dtvd88.
+* `report @dtvd88` will report @dtvd88 as a spam account.

 
 

-* ```h```will show the help.
+__Screening Commands__

 
 

-* ```c```will clear the screen.
+* `h` will show the help.

 
 

-* ```q```will quit.
+* `c` will clear the screen.
+
+* `q` will quit.
+
+__Switching Stream Commands__
+
+* `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.
+
+__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_rainow('wahahaha')` will make more fun :)

 
 For example see the screenshot above.
 
 
 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)
 
 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
 ## License
 Rainbow Stream are released under an MIT License. See LICENSE.txt for details