X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.md;h=0a5b44d9f55f33c8f27ed38d4bfc704346dd0a10;hp=0a3c376d065ec3e6ee773fe1b78341e88d191c44;hb=78b81730b2f2be93408cedf2bf9cab223956a443;hpb=13b5b8546c6d34c747faf9447f9d2eb26c81b7ff;ds=sidebyside diff --git a/README.md b/README.md index 0a3c376..0a5b44d 100644 --- 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 @@ -30,11 +32,14 @@ sudo pip install git+https://github.com/DTVD/rainbowstream.git ## Usage ```bash -rainbowstream +rainbow ``` 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. +While the rainbow stream is continued, you can search, reply, retweet, tweet directly from terminal ... +Type 'h' to view full help or use TAB auto-completion to see what is available. + + ## License Rainbow Stream are released under an MIT License. See LICENSE.txt for details