rst

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index 4d36dc22521be5a2b62d94568d7bb383a840d79a..692514dd2dffb86aa304a3baabbf480e772f74a4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,16 +1,16 @@
-## Rainbow Stream 
+## Rainbow Stream

 
 

-[![Download](http://img.shields.io/pypi/dm/rainbowstream.svg)](https://pypi.python.org/pypi/rainbowstream/0.0.3)
-[![Version](http://img.shields.io/pypi/v/rainbowstream.svg)](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).

 
 ## Screenshot
 
 ## Screenshot

-![v0.0.1](./screenshot/RainbowStream.png)
-![v0.0.3](./screenshot/RainbowStreamIOT.png)
+![rainbowstream](./screenshot/RainbowStream.png)
+![rainbowstreamIOT](./screenshot/RainbowStreamIOT.png)

 
 ## Install
 You will need Python 2.7+ and pip.
 
 ## Install
 You will need Python 2.7+ and pip.


@@ -44,56 +44,75 @@ 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```
+__Action Commands__

 
 

-* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
+* `trend` will show global trending topics. `trend US` will show trends in United States while `trend JP Tokyo` will show trends in Tokyo/Japan.

 
 

-    ```Only nicks``` decide what nicks will be include only.
+* `home` will show your timeline. `home 10` will print exactly 10 tweets.

 
 

-    ```Ignore nicks```decide what nicks will be exclude.
+* `view @mdo` will show @mdo 's timeline. `view @dmo 9` will print exactly 9 tweets.

 
 

-* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
-You can setup 2 list above at ```config.py```
+* `mentions` will show mentions timeline. `mentions 7` will show 7 mention tweets.

 
 

-* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
+* `t the rainbow is god's promise to noah` will tweet exactly *'the rainbow is god's promise to noah'*.

 
 

-__Action Command__
+* `rt 12` will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.

 
 

-* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
+* `fav 12` will favorite the tweet with *[id=12]*.

 
 

-* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
+* `rep 12 Really` will reply *'Really'* to the tweet with *[id=12]*.

 
 

-* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
+* `del 12` will delete tweet with *[id=12]*.

 
 

-* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
+* `ufav 12` will unfavorite tweet with *[id=12]*.

 
 

-* ```fav 12```will favorite the tweet with *[id=12]*.
+* `s #noah` will search the word *'noah'*. Result will come back with highlight.

 
 

-* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
+* `mes @dtvd88 hi` will send a `hi` message to @dtvd88.

 
 

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

 
 

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

 
 

-* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
+* `ls fr` will list all your friends (people who you are following).

 
 

-* ```show image 12``` will show the image in tweet with *[id=12]* in your OS's image viewer.
+* `inbox` will show inbox messages. `inbox 7` will show newest 7 messages.

 
 

-* ```fl @dtvd88```will follow @dtvd88.
+* `sent` will show sent messages. `sent 7` will show newest 7 messages.

 
 

-* ```ufl @dtvd88```will unfollow @dtvd88.
+* `trash 5` will remove message with *[message_id=5]*

 
 

-* ```h```will show the help.
+* `whois @dtvd88` will show profile of @dtvd88.

 
 

-* ```c```will clear the screen.
+* `fl @dtvd88` will follow @dtvd88.

 
 

-* ```q```will quit.
+* `ufl @dtvd88` will unfollow @dtvd88.
+
+* `h` will show the help.
+
+* `c` will clear the screen.
+
+* `q` will quit.
+
+__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.

 
 For example see the screenshot above.
 
 ## Bug Report
 
 For example see the screenshot above.
 
 ## Bug Report

-Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new) 
+Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)

 or contact me at [@dtvd88](https://twitter.com/dtvd88)
 
 ## License
 or contact me at [@dtvd88](https://twitter.com/dtvd88)
 
 ## License