fix typo
[rainbowstream.git] / README.md
index 8638c02..53ba885 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,34 +1,23 @@
-## Rainbow Stream
-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.
+## 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. 
+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)
 
 ## Screenshot
-![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
+![v0.0.1](./screenshot/RainbowStream.png)
+![v0.0.3](./screenshot/RainbowStreamIOT.png)
 
 ## Install
-**The recommened way:**
-* Clone this repo
-* Create virtualenv (optional but recommended)
-* Install dependencies
-* Install the package itself
-
-```bash
-git clone https://github.com/DTVD/rainbowstream.git
-cd rainbowstream
-virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv"
-source venv/bin/activate
-pip install -e .
-```
-**The quick way:**
-* Install everything over the air
+You will need Python 2.7+ and pip.
 
 ```bash
-sudo pip install git+https://github.com/DTVD/rainbowstream.git
+pip install rainbowstream
 ```
-**Note the I only support Python version 2.7+**
 
 ## Usage
 #### The stream
@@ -38,77 +27,78 @@ rainbow
 ```
 and see your stream.
 
+I shipped a feature which can display **tweet's images directly on terminal**.
+You can try it with:
+```bash
+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 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
+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
+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.
 
 Here is full list of supported command
 
-```bash
-[@dtvd88]home 
-```
-Show your timeline. A number come after will decide number of tweets to print. Ex 'home 10'.
+__Stream Command__
+* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
 
-```bash
-[@dtvd88]view @mdo 
-```
-Show @mdo 's timeline.
+* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
 
-```bash
-[@dtvd88]t the rainbow is god's promise to noah
-```
-Tweet exactly 'the rainbow is god's promise to noah'
+    ```Only nicks``` decide what nicks will be include only.
 
-```bash
-[@dtvd88]rt 1
-```
-Retweet the tweet with [id=1]. You can see id of each tweet beside the time.
+    ```Ignore nicks```decide what nicks will be exclude.
 
-```bash
-[@dtvd88]rep 1 Really
-```
-Reply 'Really' to the tweet with [id=1].
+* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
+You can setup 2 list above at ```config.py```
 
-```bash
-[@dtvd88]del 1
-```
-Delete thw tweet with [id=1].
+* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
 
-```bash
-[@dtvd88]s #noah
-```
-Search the word 'noah'. Result will come back with highlight.
+__Action Command__
 
-```bash
-[@dtvd88]fr
-```
-List all friend (You are following people).
+* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
 
-```bash
-[@dtvd88]fl
-```
-List all follower.
+* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
 
-```bash
-[@dtvd88]h
-```
-SHow the help.
+* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
 
-```bash
-[@dtvd88]c
-```
-Clear the screen.
+* ```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]*.
 
-```bash
-[@dtvd88]q
-```
-Quit.
+* ```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.
+
+* ```show image 12``` will show the image in tweet with *[id=12]* in your OS's image viewer.
+
+* ```ls fl```will list all your followers (people who are following you).
+
+* ```ls fr```will list all your friends (people who you are following).
+
+* ```fl @dtvd88```will follow @dtvd88.
+
+* ```ufl @dtvd88```will unfollow @dtvd88.
+
+* ```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