search from config
[rainbowstream.git] / README.md
index 0a3c376..98c3d5d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 ## Rainbow Stream
-Terminal-based Twitter Client with Streaming API support. Only supports Python 2.7 or later.
+Terminal-based Twitter Client with Streaming API support. 
+Realtime tweetstream, compose, search ... and much more fun directly from terminal.
+Only supports Python 2.7 or later.
 
 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)
 
@@ -7,7 +9,7 @@ This package build on the top of [Python Twitter Tool](http://mike.verdone.ca/tw
 ![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
 
 ## Install
-**The easy way:**
+**The recommened way:**
 * Clone this repo
 * Create virtualenv (optional but recommended)
 * Install dependencies
@@ -29,12 +31,53 @@ sudo pip install git+https://github.com/DTVD/rainbowstream.git
 **Note the I only support Python version 2.7+**
 
 ## Usage
+#### The stream
+Just type
 ```bash
-rainbowstream
+rainbow
 ```
-In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
+and see your stream.
 
+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 the rainbow stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
+Simply hit Enter key and type "h" to view 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
+
+* ```home```will show your timeline. A number come after will decide number of tweets to print. Ex 'home 10'.
+
+* ```view @mdo```will show @mdo 's timeline.
+
+* ```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]*.
+
+* ```del 12```will delete thw 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.
+
+* ```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) 
+or contact me at [@dtvd88](https://twitter.com/dtvd88)
+
 ## License
 Rainbow Stream are released under an MIT License. See LICENSE.txt for details