Update README.rst

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 4756f6f8f58dab0fb57fb12ac9725f8492890155..a9a3e00e509c7a6ffff9deee536b00fafd8edd7e 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -61,7 +61,7 @@ You can try it with:
 \r
     rainbowstream -iot # Or rainbowstream --image-on-term\r
 \r
-You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app \r
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app\r
 to enable above feature (see `config management`_ section).\r
 \r
 In the first time you will be asked for authorization of Rainbow Stream\r
@@ -219,8 +219,8 @@ Here is full list of supported command:
 \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
+  + ``theme monokai`` will apply *monokai* theme immediately.\r
+  + Changed theme will be remember as the next time's default theme.\r
 \r
 -  ``config`` will list all config key.\r
 \r
@@ -233,6 +233,10 @@ Here is full list of supported command:
 \r
 -  ``h`` will show the help.\r
 \r
+-  ``p`` will pause the stream.\r
+\r
+-  ``r`` will unpause the stream.\r
+\r
 -  ``c`` will clear the screen.\r
 \r
 -  ``q`` will quit.\r
@@ -307,6 +311,24 @@ You can view or set a new value of every config key by ``config`` command (See *
 \r
 -  ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
 \r
+-  ``FORMAT``: display format for tweet and message.\r
+\r
+  + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.\r
+  + ``DISPLAY``: decide how tweet will be printed.\r
+\r
+    + ``#name``: Twitter's name\r
+    + ``#nick``: Twitter's screen name\r
+    + ``#clock``: Datetime\r
+    + ``#id``: ID\r
+    + ``#fav``: favorited symbol\r
+    + ``#tweet``: Tweet's content\r
+    + ``#sender_name``: Message's sender name\r
+    + ``#sender_nick``: Message's sender screen name\r
+    + ``#to``: '>>>' symbol\r
+    + ``#recipient_name``: Message's recipient name\r
+    + ``#recipient_nick``: Message's recipient screen name\r
+\r
+\r
 Development\r
 -----------\r
 \r
@@ -345,4 +367,6 @@ steps
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
 .. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r
+.. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime\r
+\r
 \r