Skip to content
This repository was archived by the owner on Sep 15, 2024. It is now read-only.

Commit ff8ef47

Browse files
committed
Flesh out readme
1 parent 7a13e15 commit ff8ef47

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

+29-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,34 @@
11
oslatlong
22
=========
33

4-
Quickly conceived app to query OSM's Nominatim geocoding API.
4+
[Quickly conceived app](https://news.ycombinator.com/item?id=30301118) to query OSM's [Nominatim](https://nominatim.openstreetmap.org/ui/search.html) geocoding [API](https://nominatim.org/release-docs/latest/api/Overview/).
55

6+
## How do I install it?
67

8+
### Homebrew (Mac)
9+
```
10+
brew install oogali/tap/oslatlong
11+
```
12+
13+
## How do I use it?
14+
15+
### Examples
16+
17+
#### Return all matching coordinates
18+
```
19+
oslatlong "Berlin, Germany"
20+
```
21+
22+
#### Return only the first matching coordinate
23+
```
24+
oslatlong -n 1 "Berlin, Germany"
25+
```
26+
27+
#### Return all matching coordinates, but prefix with the query
28+
```
29+
oslatlong -s "Berlin, Germany"
30+
```
31+
32+
## Why did you make this?
33+
34+
I needed a distraction and this seemed to scratch that itch.

0 commit comments

Comments
 (0)