improve search query
[rainbowstream.git] / docs / index.rst
index 56b97a5..a11e7da 100644 (file)
@@ -161,11 +161,9 @@ Here is full list of supported command:
 \r
 **Direct Messages Commands**\r
 \r
--  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
-   messages.\r
+-  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7 messages.\r
 \r
--  ``sent`` will show sent messages. ``sent 7`` will show newest 7\r
-   messages.\r
+-  ``thread 2`` will show full thread with [id=2].\r
 \r
 -  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
 \r
@@ -305,8 +303,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
+Rainbow Stream has a custom config file located at ``~/.rainbow_config.json`` which will be loaded **after** its `default config`_. You are free to change anything on your custom config, but if you messed up with JSON format, the app would still works fine. Simply overwrite your custom config withe the `default config`_ to solve format problems.\r
+\r
+You also can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
 \r
 -  ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.\r
 \r
@@ -320,6 +319,8 @@ You can view or set a new value of every config key by ``config`` command (See *
 \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
@@ -334,6 +335,12 @@ You can view or set a new value of every config key by ``config`` command (See *
     + ``#owner``: owner's username with '@'\r
     + ``#tweet``: original tweet\r
 \r
+-  ``THREAD_META_LEFT``: format for meta information of messages from partner which is display in the left of screen.\r
+\r
+-  ``THREAD_META_RIGHT``: format for meta information of messages from you which is display in the right of screen.\r
+\r
+-  ``THREAD_MIN_WIDTH``: minimum width of a message frame.\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
@@ -418,4 +425,5 @@ steps
 .. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime\r
 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
+.. _default config: https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/config\r
 \r