From d9c255b089de0319b6e920413fd0aaa4fdc4a1e3 Mon Sep 17 00:00:00 2001 From: Mark Joshwel Date: Fri, 1 Sep 2023 13:38:03 +0000 Subject: [PATCH] docs: update description and add cli usage --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index aaa793b..3192926 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ > [`main`](https://github.com/markjoshwel/surplus/tree/main) branch. surplus is a Python script to convert -[Google Map Plus Codes](https://maps.google.com/pluscodes/) -to iOS Shortcuts-like human-readable text. +[Google Maps Plus Codes](https://maps.google.com/pluscodes/) +to iOS Shortcuts-like shareable text. - [installation](#installation) - [command-line usage](#command-line-usaage) @@ -56,19 +56,19 @@ pip install git+https://github.com/markjoshwel/surplus.git@future ```text usage: surplus [-h] [-d] [-v] [query ...] -Plus Code to iOS-Shortcuts-like shareable text +Google Maps Plus Code to iOS Shortcuts-like shareable text positional arguments: - query full-length Plus Code (6PH58QMF+FX), - local code (8QMF+FX Singapore), or - latlong (1.3336875, 103.7749375) + query full-length Plus Code (6PH58QMF+FX), shortened + Plus Code/'local code' (8QMF+FX Singapore), + latlong (1.3336875, 103.7749375), or string + query (e.g., 'Wisma Atria') options: -h, --help show this help message and exit - -d, --debug prints lat, long and reverser - response dict to stderr - -v, --version prints version information to stderr -     and exits + -d, --debug prints lat, long and reverser response dict to + stderr + -v, --version prints version information to stderr and exits ``` ## developer's guide