X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=docs%2Findex.rst;h=f60f42ae105abc986431aa4c8e9e2611fa021451;hp=0eea1d14a04a1c3c44b60d18316d6f6c2cc97c1d;hb=25ff9ce9f367571d177e656b36c3cb06d8c4b199;hpb=8b076818dddf70ed88e606d7719a93cf62eadb55

diff --git a/docs/index.rst b/docs/index.rst
index 0eea1d1..f60f42a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,7 +10,8 @@ Rainbow Stream
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
 favorite … and much more fun directly from terminal.
 
-This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.
+This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,
+can run on Python 2.7.x and 3.x .
 
 Install
 -------
@@ -94,8 +95,8 @@ Here is full list of supported command:
 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
    exactly 9 tweets.
 
--  ``s #noah`` will search the word *‘noah’*. Result will come back with
-   highlight.
+-  ``s noah`` will search the word *‘noah’*. Result will come back with
+   highlight. Search can be performed with or without hashtag.
 
 **Tweet Commands**
 
@@ -159,6 +160,32 @@ Here is full list of supported command:
 
 -  ``report @dtvd88`` will report @dtvd88 as a spam account.
 
+**Twitter list**
+
+-  ``list`` will show all lists you are belong to.
+
+-  ``list home`` will show timeline of list. You will be asked for list's name.
+
+-  ``list all_mem`` will show list's all members.
+
+-  ``list all_sub`` will show list's all subscribers.
+
+-  ``list add`` will add specific person to a list owned by you.
+
+-  ``list rm`` will remove specific person from a list owned by you.
+
+-  ``list sub`` will subscribe you to a specific list.
+
+-  ``list unsub`` will unsubscribe you from a specific list.
+
+-  ``list own`` will show all list owned by you.
+
+-  ``list new`` will create a new list.
+
+-  ``list update`` will update a list owned by you.
+
+-  ``list del`` will delete a list owned by you.
+
 **Switching Stream Commands**
 
 -  ``switch public #AKB48`` will switch current stream to public stream
@@ -185,13 +212,21 @@ Here is full list of supported command:
   + Even ``cal`` will show the calendar for current month.
   + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)
 
-**Screening Commands**
+**Config Management**
+
+-  ``theme`` will list available themes.
 
--  ``theme`` will list available themes. 
-  
   + ``theme monokai`` will apply *monokai* theme immedaitely.
   + ``theme current_as_default`` will remember current theme as next time default.
-  
+
+-  ``config`` will list all config key.
+
+  + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.
+  + ``config ASCII_ART default`` will output default value of *ASCII_ART* config key.
+  + ``config ASCII_ART = False`` will set value of *ASCII_ART* config key to *False*.
+
+**Screening Commands**
+
 -  ``h`` will show the help.
 
 -  ``c`` will clear the screen.
@@ -230,7 +265,77 @@ Theme’s screenshot:
 
 For detaile information, see `theme usage and customization`_.
 
+Config explanation
+^^^^^^^^^^^^^^^^^^
+
+Rainbow Stream has a config file located at ``~/.rainbow_config.json``.
+You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).
+
+-  ``THEME``: current theme.
+
+-  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.
+
+-  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.
+
+-  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.
+
+-  ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.
+
+-  ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.
+
+-  ``TREND_MAX``: default trends to display on 'trend' command.
+
+-  ``LIST_MAX``: default tweets to display on 'list home' command.
+
+-  ``ONLY_LIST``: filter list on 'switch' command.
+
+-  ``IGNORE_LIST``: ignore list on 'switch' command.
+
+-  ``HISTORY_FILENAME``: name of file which stores input history.
+
+-  ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.
+
+-  ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.
+
+-  ``USER_DOMAIN``: user URL of Twitter Streaming API.
+
+-  ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.
+
+-  ``SITE_DOMAIN``: site URL of Twitter Streaming API.
+
+Development
+-----------
+
+If you want to build a runnable version yourself, follow these simple
+steps
+
+-  `Create your own Twitter Application`_
+-  Get your Twitter application’s API key and secret
+-  Fork github's repo and clone in your system.
+-  Create a file ``consumer.py`` in ```rainbowstream```_ folder with
+   following content
+
+   .. code:: python
+
+       # Consumer information
+       CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
+       CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
+
+-  Use pip to install in local
+
+   .. code:: bash
+
+       # cd to directory which contains setup.py (cloned directory)
+       virtualenv venv # Python3 users: use -p to specify python3
+       source venv/bin/activate
+       pip install -e .
+       which rainbowstream # /this-directory/venv/bin/rainbowstream
+       pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
+       # Remove ~/.rainbow_oauth if exists
+       rainbowstream # local version of rainbowstream
 
+.. _Create your own Twitter Application: https://apps.twitter.com/app/new
+.. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md