Skip to content

Commit

Permalink
README: added CLI documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanb committed May 7, 2023
1 parent 4b42c3b commit 9efd001
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Specification: https://wiki.openstreetmap.org/wiki/Shortlink

## Usage

### Creating a link
### Creating a link in Go

```go
package main
Expand All @@ -25,3 +25,16 @@ func main() {
```

Prints: [`https://osm.org/go/0Ik3VNr_A-?m`](https://osm.org/go/0Ik3VNr_A-?m)

### Command-line tool

```bash
Usage: osmshortlink [latitude] [longitude] [zoom]
```

eg:

```bash
$ osmshortlink 46.05141 14.50604 17
https://osm.org/go/0Ik3VNr_A-?m
```

0 comments on commit 9efd001

Please sign in to comment.