From c1a3d5e53fd6982f42cff73956588f0130497be7 Mon Sep 17 00:00:00 2001 From: Orakaro Date: Thu, 3 Jul 2014 21:32:14 +0900 Subject: [PATCH] Update README.rst --- README.rst | 119 +++-------------------------------------------------- 1 file changed, 5 insertions(+), 114 deletions(-) diff --git a/README.rst b/README.rst index c463b2d..6d124ef 100644 --- a/README.rst +++ b/README.rst @@ -68,7 +68,7 @@ app at Twitter. Just click the “Authorize access” button and paste PIN number to the terminal, the rainbow will start. 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 @@ -78,120 +78,9 @@ 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: +For available commands, please `Read The Docs`_. -**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. - -- ``allrt 12 20`` will list 20 newest retweets of the tweet with *[id=12]*. If the number of retweets is not specified, 5 newest retweets will be listed instead. - -- ``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. - -- ``trash 5`` will remove message with *[message\_id=5]* - -**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. - -**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. - -**Smart shell** - -- Put anything to terminal, the app will try to eval and display result as a python interactive shell. - - + ``142857*2`` or ``101**3`` like a calculator. - + Even ``cal`` will show the calendar for current month. - + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :) - -**Screening Commands** - -- ``h`` will show the help. - -- ``c`` will clear the screen. - -- ``q`` will quit. - - -For example see the screenshot above. +For themes and color setting, see `config guide`_. Bug and feature requests ------------------------ @@ -217,3 +106,5 @@ details .. _@dtvd88: https://twitter.com/dtvd88 .. _fork: https://github.com/DTVD/rainbowstream/fork .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/ +.. _Read The Dics: http://rainbowstream.readthedocs.org/en/latest/ +.. _config guide: # -- 2.25.1