sphinx
[rainbowstream.git] / docs / index.rst
index 019909c..f60f42a 100644 (file)
@@ -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
-**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
+-  ``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
@@ -260,6 +268,9 @@ For detaile information, see `theme usage and customization`_.
 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