term
[rainbowstream.git] / README.rst
index 6537e3b..c463b2d 100644 (file)
@@ -31,6 +31,15 @@ You will need Python 2.7+ and pip.
 \r
 .. code:: bash\r
 \r
+    sudo pip install rainbowstream\r
+    \r
+or try with a virtualenv\r
+\r
+.. code:: bash\r
+\r
+    sudo pip install virtualenv # skip if you already have virtualenv\r
+    virtualenv venv \r
+    source venv/bin/activate # use the brand new virtualenv.\r
     pip install rainbowstream\r
 \r
 Usage\r
@@ -99,6 +108,8 @@ Here is full list of supported command:
 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
    each tweet beside the time.\r
 \r
+-  ``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.\r
+\r
 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
 \r
 -  ``fav 12`` will favorite the tweet with *[id=12]*.\r
@@ -145,14 +156,6 @@ Here is full list of supported command:
 \r
 -  ``report @dtvd88`` will report @dtvd88 as a spam account.\r
 \r
-**Screening Commands**\r
-\r
--  ``h`` will show the help.\r
-\r
--  ``c`` will clear the screen.\r
-\r
--  ``q`` will quit.\r
-\r
 **Switching Stream Commands**\r
 \r
 -  ``switch public #AKB48`` will switch current stream to public stream\r
@@ -177,19 +180,27 @@ Here is full list of supported command:
 \r
   + ``142857*2`` or ``101**3`` like a calculator.\r
   + Even ``cal`` will show the calendar for current month.\r
-  + Put ``order_rainbow('anything')`` or ``random_rainow('wahahaha')`` will make more fun :)\r
+  + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
+\r
+**Screening Commands**\r
+\r
+-  ``h`` will show the help.\r
+\r
+-  ``c`` will clear the screen.\r
+\r
+-  ``q`` will quit.\r
 \r
 \r
 For example see the screenshot above.\r
 \r
 Bug and feature requests\r
-----------\r
+------------------------\r
 \r
 Found a bug or a feature request ? \r
 Please `create an issue`_ or contact me at `@dtvd88`_\r
 \r
 Contributing\r
-----------\r
+------------\r
 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
 You will be listed as contributor.\r
 \r
@@ -202,7 +213,6 @@ details
 \r
 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
 .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
-.. _EarthQuake: https://github.com/jugyo/earthquake\r
 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
 .. _@dtvd88: https://twitter.com/dtvd88\r
 .. _fork: https://github.com/DTVD/rainbowstream/fork\r