diff options
| author | Hsieh Chin Fan <typebrook@topo.tw> | 2023-02-06 21:26:57 +0800 |
|---|---|---|
| committer | Matěj Cepl <mcepl@cepl.eu> | 2023-03-14 08:27:38 +0100 |
| commit | cbb82ec7b9e950befa8d744725fd284e7798f7b2 (patch) | |
| tree | b552ce7de191b10fe29a7e4c2b0046a979717304 | |
| parent | 63ba479473c0f804cb3879bf66e4f49766df7797 (diff) | |
| download | osm_where-cbb82ec7b9e950befa8d744725fd284e7798f7b2.tar.gz | |
Add quick-start text into README
Some example commands help user quickly be familiar with usage
(Also, just a practice for my first patch via git send-mail)
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -7,6 +7,18 @@ we don’t have any interface to choose between multiple options). Currently defaults to looking at Ukraine. +**Quick Start**: +```bash +# Get help message +python src/osm_where.py --help + +# Query by URL +python src/osm_where.py https://www.openstreetmap.org/node/4126283179 + +# Query by place name +python src/osm_where.py --name Kropyvnytskyi +``` + All issues, questions, complaints, or (even better!) patches should be send via email to [~mcepl/devel@lists.sr.ht](mailto:~mcepl/devel@lists.sr.ht) email |