X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=docs%2Findex.rst;h=8b4e1d8ddd8da22f116217a02a53920d365d8ddb;hp=5b4971ced2e8044fe6f6404bf500cfe4c438ff0b;hb=2dd80ec91d158428a6fc2e3744ef4c25cb150b24;hpb=3681056d053a01b801cb37dd79292a878eea1901;ds=sidebyside

diff --git a/docs/index.rst b/docs/index.rst
index 5b4971c..8b4e1d8 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,26 +10,36 @@ 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.4.x .
 
 Install
 -------
 
-You will need Python 2.7+ and pip.
+The quick way
+^^^^^^^^^^^^^
+
+You will need Python and pip (2.7.x or 3.x).
 
 .. code:: bash
 
     sudo pip install rainbowstream
+    # Python 3 users: sudo pip3 install rainbowstream
+
+The recommended way
+^^^^^^^^^^^^^^^^^^^
 
-or try with a virtualenv
+Use `virtualenv`_
 
 .. code:: bash
 
-    sudo pip install virtualenv # skip if you already have virtualenv
     virtualenv venv
-    source venv/bin/activate # use the brand new virtualenv.
+    # Python 3 users : use -p to specify your Python 3 localtion as below
+    # virtualenv -p /usr/bin/python3 venv
+    source venv/bin/activate
     pip install rainbowstream
 
+
 Usage
 -----
 
@@ -96,6 +106,9 @@ Here is full list of supported command:
 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
    each tweet beside the time.
 
+-  ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,
+   the quote will be cancelled.
+
 -  ``allrt 12 20`` will list 20 newest retweets of the tweet with *[id=12]*. If the number of retweets is not specified, 5 newest retweets will be listed instead.
 
 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
@@ -109,6 +122,9 @@ Here is full list of supported command:
 -  ``show image 12`` will show the image in tweet with *[id=12]* in your
    OS’s image viewer.
 
+-  ``open 12`` will open url in tweet with *[id=12]* in your
+   OS’s default browser.
+
 **Direct Messages Commands**
 
 -  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7
@@ -144,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
@@ -172,11 +214,11 @@ Here is full list of supported command:
 
 **Screening Commands**
 
--  ``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.
-  
+
 -  ``h`` will show the help.
 
 -  ``c`` will clear the screen.
@@ -215,7 +257,38 @@ Theme’s screenshot:
 
 For detaile information, see `theme usage and customization`_.
 
+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
+-  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
+       virtualenv venv # Python3 users: use -p to specify python3
+       source venv/bin/activate
+       pip install -e .
+       pip list | grep rainbowstream # confirm installed version
+       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
+.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/