autopep8 and bumped version
[rainbowstream.git] / docs / index.rst
index 1015a51..f60f42a 100644 (file)
@@ -11,7 +11,7 @@ Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
 favorite … and much more fun directly from terminal.\r
 \r
 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
 favorite … and much more fun directly from terminal.\r
 \r
 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
-can run on Python 2.7.x and 3.4.x .\r
+can run on Python 2.7.x and 3.x .\r
 \r
 Install\r
 -------\r
 \r
 Install\r
 -------\r
@@ -95,8 +95,8 @@ Here is full list of supported command:
 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
    exactly 9 tweets.\r
 \r
 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
    exactly 9 tweets.\r
 \r
--  ``s #noah`` will search the word *‘noah’*. Result will come back with\r
-   highlight.\r
+-  ``s noah`` will search the word *‘noah’*. Result will come back with\r
+   highlight. Search can be performed with or without hashtag.\r
 \r
 **Tweet Commands**\r
 \r
 \r
 **Tweet Commands**\r
 \r
@@ -212,13 +212,21 @@ Here is full list of supported command:
   + Even ``cal`` will show the calendar for current month.\r
   + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
 \r
   + Even ``cal`` will show the calendar for current month.\r
   + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
 \r
-**Screening Commands**\r
+**Config Management**\r
 \r
 -  ``theme`` will list available themes.\r
 \r
   + ``theme monokai`` will apply *monokai* theme immedaitely.\r
   + ``theme current_as_default`` will remember current theme as next time default.\r
 \r
 \r
 -  ``theme`` will list available themes.\r
 \r
   + ``theme monokai`` will apply *monokai* theme immedaitely.\r
   + ``theme current_as_default`` will remember current theme as next time default.\r
 \r
+-  ``config`` will list all config key.\r
+\r
+  + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.\r
+  + ``config ASCII_ART default`` will output default value of *ASCII_ART* config key.\r
+  + ``config ASCII_ART = False`` will set value of *ASCII_ART* config key to *False*.\r
+\r
+**Screening Commands**\r
+\r
 -  ``h`` will show the help.\r
 \r
 -  ``c`` will clear the screen.\r
 -  ``h`` will show the help.\r
 \r
 -  ``c`` will clear the screen.\r
@@ -257,6 +265,44 @@ Theme’s screenshot:
 \r
 For detaile information, see `theme usage and customization`_.\r
 \r
 \r
 For detaile information, see `theme usage and customization`_.\r
 \r
+Config explanation\r
+^^^^^^^^^^^^^^^^^^\r
+\r
+Rainbow Stream has a config file located at ``~/.rainbow_config.json``.\r
+You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
+\r
+-  ``THEME``: current theme.\r
+\r
+-  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\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
+\r
+-  ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
+\r
+-  ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
+\r
+-  ``TREND_MAX``: default trends to display on 'trend' command.\r
+\r
+-  ``LIST_MAX``: default tweets to display on 'list home' command.\r
+\r
+-  ``ONLY_LIST``: filter list on 'switch' command.\r
+\r
+-  ``IGNORE_LIST``: ignore list on 'switch' command.\r
+\r
+-  ``HISTORY_FILENAME``: name of file which stores input history.\r
+\r
+-  ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.\r
+\r
+-  ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.\r
+\r
+-  ``USER_DOMAIN``: user URL of Twitter Streaming API.\r
+\r
+-  ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.\r
+\r
+-  ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
+\r
 Development\r
 -----------\r
 \r
 Development\r
 -----------\r
 \r