add notification command

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 28592b28e3473a6729f39412c34b766b2af0f48d..fbf68f854f2f8edf682e8f38cc23f172a6264a75 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -112,34 +112,27 @@ Here is full list of supported command:
 \r
 **Explore Commands**\r
 \r
--  ``trend`` will show global trending topics. ``trend US`` will show\r
-   trends in United States while ``trend JP Tokyo`` will show trends in\r
-   Tokyo/Japan.\r
+-  ``trend`` will show global trending topics. ``trend US`` will show trends in United States while ``trend JP Tokyo`` will show trends in Tokyo/Japan.\r
 \r
--  ``home`` will show your timeline. ``home 10`` will print exactly 10\r
-   tweets.\r
+-  ``home`` will show your timeline. ``home 10`` will print exactly 10 tweets.\r
 \r
--  ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
-   mention tweets.\r
+-  ``notification`` will show your notification from the time you started RainbowStream.\r
+\r
+-  ``mentions`` will show mentions timeline. ``mentions 7`` will show 7 mention tweets.\r
 \r
 -  ``whois @dtvd88`` will show profile of @dtvd88.\r
 \r
--  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
-   exactly 9 tweets.\r
+-  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print exactly 9 tweets.\r
 \r
--  ``s noah`` will search the word *‘noah’*. Result will come back with\r
-   highlight. Search can be performed with or without hashtag.\r
+-  ``s noah`` will search the word *‘noah’*. Result will come back with highlight. Search can be performed with or without hashtag.\r
 \r
 **Tweet Commands**\r
 \r
--  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
-   rainbow is god’s promise to noah’*.\r
+-  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the rainbow is god’s promise to noah’*.\r
 \r
--  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
-   each tweet beside the time.\r
+-  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.\r
 \r
--  ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,\r
-   the quote will be cancelled.\r
+-  ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added, the quote will be cancelled.\r
 \r
 -  ``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.\r
 \r
@@ -153,11 +146,9 @@ Here is full list of supported command:
 \r
 -  ``del 12`` will delete tweet with *[id=12]*.\r
 \r
--  ``show image 12`` will show the image in tweet with *[id=12]* in your\r
-   OS’s image viewer.\r
+-  ``show image 12`` will show the image in tweet with *[id=12]* in your OS’s image viewer.\r
 \r
--  ``open 12`` will open url in tweet with *[id=12]* in your\r
-   OS’s default browser.\r
+-  ``open 12`` will open url in tweet with *[id=12]* in your OS’s default browser.\r
 \r
 **Direct Messages Commands**\r
 \r
@@ -171,8 +162,7 @@ Here is full list of supported command:
 \r
 **Friends and followers Commands**\r
 \r
--  ``ls fl`` will list all your followers (people who are following\r
-   you).\r
+-  ``ls fl`` will list all your followers (people who are following you).\r
 \r
 -  ``ls fr`` will list all your friends (people who you are following).\r
 \r
@@ -220,21 +210,17 @@ Here is full list of supported command:
 \r
 **Switching Stream Commands**\r
 \r
--  ``switch public #AKB48`` will switch current stream to public stream\r
-   and track keyword ``AKB48``\r
+-  ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r
 \r
--  ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
-   to provide 2 list:\r
+-  ``switch public #AKB48 -f`` will do exactly as above but will ask you to provide 2 list:\r
 \r
    ``Only nicks`` decide what nicks will be include only.\r
 \r
    ``Ignore nicks``\ decide what nicks will be exclude.\r
 \r
--  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
-   *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
+-  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
 \r
--  ``switch mine`` will switch current stream to personal stream. ``-f``\r
-   and ``-d`` will work as well.\r
+-  ``switch mine`` will switch current stream to personal stream. ``-f`` and ``-d`` will work as well.\r
 \r
 **Smart shell**\r
 \r
@@ -319,6 +305,8 @@ You also can view or set a new value of every config key by ``config`` command (
 \r
 -  ``PREFIX``: display string of prompt.\r
 \r
+-  ``SEARCH_TYPE``: search type in 'search' command ('mixed','recent','popular').\r
+\r
 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
 \r
 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r