X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=docs%2Findex.rst;h=e4ed9a0d6cbc895ded85426770075b20944eaa7b;hp=990130ddba83f060dcfe6a998bda6d627964739e;hb=2d34102927771794440b85c6b15c4a1d35f23dd0;hpb=aa835f48fa245bd3cc29564aaee89004d743d05d

diff --git a/docs/index.rst b/docs/index.rst
index 990130d..e4ed9a0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -96,6 +96,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 +112,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
@@ -172,11 +178,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.
@@ -193,21 +199,59 @@ You can either change theme by ``theme`` command or create your favorite one.
 
 Theme’s screenshot:
 
+- Monokai
+
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
    :alt: monokai
 
+- Solarized
+
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
    :alt: solarized
 
+- Tomorrow Night
+
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
    :alt: tomorrownight
 
+- Larapaste
+
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
    :alt: larapaste
 
 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