X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.md;h=53ba885302231089484c038aa3a03f7854afee42;hp=63b97041250bbf0630a0ba93c5636a889736028b;hb=b5f9288841e25fb07ea24abf9d53e169aecba582;hpb=4b39ea814ff8b2c76411b7095e72ee9c071c7304;ds=sidebyside diff --git a/README.md b/README.md index 63b9704..53ba885 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,16 @@ -## 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. 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/develop/screenshot/RainbowStreamvSS(Image).png) +![v0.0.1](./screenshot/RainbowStream.png) +![v0.0.3](./screenshot/RainbowStreamIOT.png) ## Install You will need Python 2.7+ and pip. @@ -22,9 +27,10 @@ rainbow ``` and see your stream. -In the case you want to see photos directly in terminal, the command is +I shipped a feature which can display **tweet's images directly on terminal**. +You can try it with: ```bash -rainbow -img 1 # or rainbow --image 1 +rainbow -iot # Or rainbow --image-on-term ``` In the first time you will be asked for authorization of Rainbow Stream app at Twitter. @@ -32,9 +38,9 @@ Just click the "Authorize access" button and paste PIN number to the terminal, t #### The interactive mode 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 +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 @@ -72,9 +78,15 @@ __Action Command__ * ```s #noah```will search the word *'noah'*. Result will come back with highlight. -* ```fr```will list all friend (You are following people). +* ```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. -* ```fl```will list all follower. +* ```ufl @dtvd88```will unfollow @dtvd88. * ```h```will show the help.