From a9ea2f21edec2d3318f6ad5478ab95c79106728c Mon Sep 17 00:00:00 2001
From: Elia El Lazkani <eliaellazkani@gmail.com>
Date: Wed, 28 Aug 2019 21:52:22 +0200
Subject: [PATCH] Expanding the readme

---
 README.rst | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 74 insertions(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index 33f323c..ba68233 100644
--- a/README.rst
+++ b/README.rst
@@ -1,4 +1,77 @@
 cmw
 ===
 
-`cmw` is a command line weather application that queries `wttr.in`.
+`cmw` is a command line weather application that queries `wttr.in <https://wttr.in>`_.
+
+Usage
+=====
+
+.. code:: text
+
+    $ cmw --help
+    usage: cmw [-h] [-L LOCATION] [-f FORMAT] [-l LANG] [-m] [-u] [-M] [-z] [-o]
+               [-w] [-A] [-F] [-n] [-q] [-Q] [-N] [-P] [-p] [-T] [-t TRANSPARENCY]
+               [--v2] [--version]
+
+    Get the weather!
+
+    optional arguments:
+    -h, --help            show this help message and exit
+    -L LOCATION, --location LOCATION
+                            Location (look at epilog for more information)
+    -f FORMAT, --format FORMAT
+                            Query formatting
+    -l LANG, --lang LANG  The language to use
+    -m, --metric          Units: Metric (SI) (default outside US)
+    -u, --uscs            Units: USCS (default in US)
+    -M, --meter-second    Units: Show wind speed in m/s
+    -z, --zero            View: Only current weather
+    -o, --one             View: Current weather & one day
+    -w, --two             View: Current weather & two days
+    -A, --ignore-user-agent
+                            View: Force ANSI output format
+    -F, --follow-link     View: Show the 'Follow' line from upstream
+    -n, --narrow          View: Narrow version
+    -q, --quiet           View: Quiet version
+    -Q, --super-quiet     View: Super quiet version
+    -N, --no-colors       View: Switch terminal sequences off
+    -P, --png             PNG: Generate PNG file
+    -p, --add-frame       PNG: Add frame around output
+    -T, --mid-transparency
+                            PNG: Make transparency 150
+    -t TRANSPARENCY, --transparency TRANSPARENCY
+                            PNG: Set transparency between 0 and 255
+    --v2                  v2 interface of the day
+    --version             show program's version number and exit
+
+        Supported Location Types
+        ------------------------
+        City name:                  Paris
+        Unicode name:               Москва
+        Airport code (3 letters):   muc
+        Domain name:                @stackoverflow.com
+        Area code:                  94107
+        GPS coordinates:            -78.46,106.79
+
+        Special Location
+        ----------------
+        Moon phase (add ,+US
+        or ,+France
+        for these cities):          moon
+        Moon phase for a date:      moon@2016-10-25
+
+        Supported languages
+        -------------------
+
+        Supported: af da de el et fr fa hu id it nb nl pl pt-br ro ru tr uk vi
+
+
+Advanced Usage
+==============
+
+.. code:: text
+
+    $ cmw -L London -f "?format=%l:+%c+%t"
+    london: ☀️ +21°C
+
+Please check `wttr.in <https://github.com/chubin/wttr.in>`_ for more information.