Update README.md

SheffieldSolar · May 3, 2023 · c2e6ff6 · c2e6ff6
1 parent 31014d9
commit c2e6ff6
Showing 1 changed file with 14 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -96,37 +96,32 @@ This utility can be used to download data to a CSV file:
 
 ```
 >> pv_live -h
-usage: pvlive.py [-h] [-s "<yyyy-mm-dd HH:MM:SS>"]
-                 [-e "<yyyy-mm-dd HH:MM:SS>"] [--entity_type <entity_type>]
-                 [--entity_id <entity_id>] [--period <5|30>] [-q]
-                 [-o </path/to/output/file>] [-http <http_proxy>]
-                 [-https <https_proxy>]
+usage: pv_live [-h] [-s "<yyyy-mm-dd HH:MM:SS>"] [-e "<yyyy-mm-dd HH:MM:SS>"]
+               [--entity_type <entity_type>] [--entity_id <entity_id>] [--period <5|30>]
+               [-q] [-o </path/to/output/file>] [-http <http_proxy>] [-https <https_proxy>]
 
 This is a command line interface (CLI) for the PV_Live API module
 
-optional arguments:
+options:
   -h, --help            show this help message and exit
   -s "<yyyy-mm-dd HH:MM:SS>", --start "<yyyy-mm-dd HH:MM:SS>"
-                        Specify a UTC start date in 'yyyy-mm-dd HH:MM:SS'
-                        format (inclusive), default behaviour is to retrieve
-                        the latest outturn.
+                        Specify a UTC start date in 'yyyy-mm-dd HH:MM:SS' format
+                        (inclusive), default behaviour is to retrieve the latest outturn.
   -e "<yyyy-mm-dd HH:MM:SS>", --end "<yyyy-mm-dd HH:MM:SS>"
-                        Specify a UTC end date in 'yyyy-mm-dd HH:MM:SS' format
-                        (inclusive), default behaviour is to retrieve the
-                        latest outturn.
+                        Specify a UTC end date in 'yyyy-mm-dd HH:MM:SS' format (inclusive),
+                        default behaviour is to retrieve the latest outturn.
   --entity_type <entity_type>
-                        Specify an entity type, either 'gsp' or 'pes'. Default
-                        is 'gsp'.
+                        Specify an entity type, either 'gsp' or 'pes'. Default is 'gsp'.
   --entity_id <entity_id>
                         Specify an entity ID, default is 0 (i.e. national).
-  --period <5|30>       Desired temporal resolution (in minutes) for PV
-                        outturn estimates. Default is 30.
+  --period <5|30>       Desired temporal resolution (in minutes) for PV outturn estimates.
+                        Default is 30.
   -q, --quiet           Specify to not print anything to stdout.
   -o </path/to/output/file>, --outfile </path/to/output/file>
                         Specify a CSV file to write results to.
-  -http <http_proxy>, -http-proxy <http_proxy>
+  -http <http_proxy>, --http-proxy <http_proxy>
                         HTTP Proxy address
-  -https <https_proxy>, -https-proxy <https_proxy>
+  -https <https_proxy>, --https-proxy <https_proxy>
                         HTTPS Proxy address
 
 Jamie Taylor & Ethan Jones, 2018-06-04
@@ -190,4 +185,4 @@ In order to maintain a local copy of the PV_Live GB national outturn estimates t
 
 ## License
 
-No license is defined yet - use at your own risk.
+No license is defined yet - use at your own risk.