documenting config

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 109799f3f75c82ff8b368e4300cab08dcb28fc67..b36f20179027893ab1576c58545ad18fbdb1cd5e 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -257,6 +257,17 @@ Theme’s screenshot:
 \r
 For detaile information, see `theme usage and customization`_.\r
 \r
+Config explanation\r
+^^^^^^^^^^^^^^^^^^\r
+\r
+-  ``THEME`` theme.\r
+\r
+-  ``ASCII_ART`` Boolen value, decide to diplay your twitter name by ascii art at stream begin or not.\r
+\r
+-  ``SEARCH_MAX_RECORD`` : max tweets can display on a 'search' command.\r
+\r
+-  ``HOME_TWEET_NUM`` : default tweets to display on a 'home' command.\r
+\r
 Development\r
 -----------\r
 \r