Merge pull request #73 from polarkac/custom_prefix

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 76167ed8051e228907120de6ed6ab3954095d79d..9dd732e337696fdf94a99b57ed38a1d4b26dae90 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,6 +13,10 @@ favorite … and much more fun directly from terminal.
 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
 can run on Python 2.7.x and 3.x .\r
 \r
+Home page : http://www.rainbowstream.org/\r
+\r
+Source code : https://github.com/DTVD/rainbowstream\r
+\r
 Install\r
 -------\r
 \r
@@ -319,7 +323,12 @@ You also can view or set a new value of every config key by ``config`` command (
 \r
 -  ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.\r
 \r
--  ``PREFIX``: display string of prompt.\r
+-  ``PREFIX``: display formated string of prompt.\r
+\r
+    + ``#me``: Your username with '@'\r
+    + ``#place``: Current list name or public for public stream\r
+    + ``#owner``: Owner of the current list\r
+    + ``#keyword``: Keyword for a public stream\r
 \r
 -  ``SEARCH_TYPE``: search type in 'search' command ('mixed','recent','popular').\r
 \r