Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
9seconds committed Feb 19, 2021
1 parent 808238f commit 69416bd
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,29 @@ or simple build Docker container
$ docker build -t topographer .
```

Also, there is an image on docker hub:
https://hub.docker.com/r/nineseconds/topographer/

Installing
==========

Installation is simple as

```shell
$ go get github.com/9seconds/topographer
```

(but if you want, you can find prebuilt binaries on [releases page](https://github.com/9seconds/topographer/releases))

We also have Docker images in both DockerHub and Github Container Registry:

```shell
$ docker pull nineseconds/topographer
```

and

```shell
$ docker pull ghcr.io/9seconds/topographer:master
```

Running the application
=======================
Expand All @@ -79,4 +99,4 @@ $ docker run -v /path/to/local/config.hjson:/config.hjson -p 8000:80 nineseconds
API
===

Please see OpenAPI specification.
Please see [OpenAPI specification](https://github.com/9seconds/topographer/blob/master/openapi.yaml).

0 comments on commit 69416bd

Please sign in to comment.