term

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index cc633747ab095253263237a551a318daaf82fa4b..c463b2dbc3a4f889ea942e60e70279730db2a5b3 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -12,8 +12,11 @@ favorite … and much more fun directly from terminal.
 \r
 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
 \r
-Screenshot\r
+Showcase\r
 ----------\r
+Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s \r
+\r
+Screenshot: \r
 \r
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
    :alt: rainbowstream\r
@@ -28,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
@@ -96,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
@@ -142,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
@@ -168,15 +174,36 @@ Here is full list of supported command:
 -  ``switch mine`` will switch current stream to personal stream. ``-f``\r
    and ``-d`` will work as well.\r
 \r
+**Smart shell**\r
+\r
+- Put anything to terminal, the app will try to eval and display result as a python interactive shell.\r
+\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_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 Report\r
-----------\r
+Bug and feature requests\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
+I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
+You will be listed as contributor.\r
+\r
 License\r
 -------\r
 \r
@@ -186,6 +213,7 @@ 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
+.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r