document
[rainbowstream.git] / README.md
index 97b751d..9e6014e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Realtime tweetstream, compose, search , favorite ... and much more fun directly
 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).
 
 ## Showcase
-Screencast: 
+Screencast:
 https://www.youtube.com/watch?v=tykCvPMJq8s
 <br>
 
@@ -22,9 +22,18 @@ Screenshot:
 You will need Python 2.7+ and pip.
 
 ```bash
+sudo pip install rainbowstream
+```
+
+or try with a virtualenv
+```bash
+sudo pip install virtualenv # skip if you already have virtualenv
+virtualenv venv
+source venv/bin/activate # use the brand new virtualenv.
 pip install rainbowstream
 ```
 
+
 ## Usage
 #### The stream
 Just type
@@ -42,104 +51,28 @@ 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
+## 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.
 
 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
-
-__Explore Commands__
-
-* `trend` will show global trending topics. `trend US` will show trends in United States while `trend JP Tokyo` will show trends in Tokyo/Japan.
-
-* `home` will show your timeline. `home 10` will print exactly 10 tweets.
-
-* `mentions` will show mentions timeline. `mentions 7` will show 7 mention tweets.
-
-* `whois @dtvd88` will show profile of @dtvd88.
-
-* `view @mdo` will show @mdo 's timeline. `view @dmo 9` will print exactly 9 tweets.
-
-* `s #noah` will search the word *'noah'*. Result will come back with highlight.
-
-__Tweet Commands__
-
-* `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]*.
-
-* `fav 12` will favorite the tweet with *[id=12]*.
-
-* `ufav 12` will unfavorite tweet with *[id=12]*.
-
-* `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.
-
-__Direct Messages Commands__
-
-* `inbox` will show inbox messages. `inbox 7` will show newest 7 messages.
-
-* `sent` will show sent messages. `sent 7` will show newest 7 messages.
-
-* `mes @dtvd88 hi` will send a `hi` message to @dtvd88.
+For available commands, please [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/).
 
-* `trash 5` will remove message with *[message_id=5]*
+For themes and color setting, see [config guide](#).
 
-__Friends and followers Commands__
-
-* `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.
-
-* `mute @dtvd88` will mute @dtvd88.
-
-* `unmute @dtvd88` will unmute @dtvd88.
-
-* `muting` will list muting users.
-
-* `block @dtvd88` will block @dtvd88.
-
-* `unblock @dtvd88` will unblock @dtvd88.
-
-* `report @dtvd88` will report @dtvd88 as a spam account.
-
-__Screening Commands__
-
-* `h` will show the help.
-
-* `c` will clear the screen.
-
-* `q` will quit.
-
-__Switching 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
+## Bug and feature requests
+Found a bug or a feature request ?
 Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
 or contact me at [@dtvd88](https://twitter.com/dtvd88)
 
+## Contributing
+I appreciate any help and support. Feel free to
+[fork](https://github.com/DTVD/rainbowstream/fork)
+and
+[create a pull request](https://github.com/DTVD/rainbowstream/compare/).
+You will be listed as contributor.
+
 ## License
 Rainbow Stream are released under an MIT License. See LICENSE.txt for details