X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=docs%2Findex.rst;h=f60f42ae105abc986431aa4c8e9e2611fa021451;hp=1015a519cafad13dfa166d4ca4243cd6e07a0df3;hb=a8c5fce4b567697790144ec15546ce68e5469963;hpb=9e1f9d5633690fee849e6ce4eb0af5ba112f2576;ds=sidebyside

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