docs: update example (#11)
This commit is contained in:
parent
e76bab61c3
commit
8645deea0f
16
README.md
16
README.md
|
@ -46,19 +46,21 @@ pip install git+https://github.com/markjoshwel/surplus
|
||||||
### Command-line Interface
|
### Command-line Interface
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: surplus [-h] [-d] query [query ...]
|
usage: surplus [-h] [-d] [-v] [query ...]
|
||||||
|
|
||||||
Plus Code to iOS-Shortcuts-like shareable text
|
Plus Code to iOS-Shortcuts-like shareable text
|
||||||
|
|
||||||
positional arguments:
|
positional arguments:
|
||||||
query full-length Plus Code (6PH58QMF+FX),
|
query full-length Plus Code (6PH58QMF+FX),
|
||||||
local code (8QMF+FX Singapore), or
|
local code (8QMF+FX Singapore), or
|
||||||
latlong (1.3336875, 103.7749375)
|
latlong (1.3336875, 103.7749375)
|
||||||
|
|
||||||
options:
|
options:
|
||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
-d, --debug prints lat, long and reverser response
|
-d, --debug prints lat, long and reverser
|
||||||
dict to stderr
|
response dict to stderr
|
||||||
|
-v, --version prints version information to stderr
|
||||||
|
and exits
|
||||||
```
|
```
|
||||||
|
|
||||||
### API Reference
|
### API Reference
|
||||||
|
|
Loading…
Reference in a new issue