Skip to content

Commit 54ecb00

Browse files
authored
update of readme with badge and deployment information (#3)
* adding build badge to readme * update readme adding section on how to pull and run with Docker
1 parent be86929 commit 54ecb00

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# TibiaData API in Golang
22

3+
[![GitHub CI](https://github.com/TibiaData/tibiadata-api-go/workflows/build/badge.svg?branch=main)](https://github.com/TibiaData/tibiadata-api-go/actions?query=workflow%3Abuild)
34
[![GitHub go.mod version](https://img.shields.io/github/go-mod/go-version/tibiadata/tibiadata-api-go)](https://github.com/tibiadata/tibiadata-api-go/blob/main/go.mod)
45
[![Docker version](https://img.shields.io/docker/v/tibiadata/tibiadata-api-go/latest)](https://hub.docker.com/r/tibiadata/tibiadata-api-go)
56
[![Docker size](https://img.shields.io/docker/image-size/tibiadata/tibiadata-api-go/latest)](https://hub.docker.com/r/tibiadata/tibiadata-api-go)
@@ -12,6 +13,7 @@ Current status of v3 is in beta and information like documentation can be found
1213
### Table of Contents
1314

1415
- [How to use](#how-to-use)
16+
- [Docker](#docker)
1517
- [Docker-compose](#docker-compose)
1618
- [Local development](#local-development)
1719
- [Environment variables](#environment-variables)
@@ -26,6 +28,20 @@ You can either use it in a Docker container or go download the code and deploy i
2628

2729
Keep in mind that there are restrictions on tibia.com that might impact the usage of the application being hosted yourself.
2830

31+
### Docker
32+
33+
Our images are available on both [GitHub Container Registry](https://github.com/TibiaData/tibiadata-api-go/pkgs/container/tibiadata-api-go) and [Docker Hub](https://hub.docker.com/r/tibiadata/tibiadata-api-go).
34+
35+
This is how to pull and run the _latest_ release of TibiaData from [GHCR](https://github.com/TibiaData/tibiadata-api-go/pkgs/container/tibiadata-api-go):
36+
37+
```console
38+
docker pull ghcr.io/tibiadata/tibiadata-api-go:latest
39+
docker run -p 127.0.0.1:80:8080/tcp --rm -it ghcr.io/tibiadata/tibiadata-api-go:latest
40+
```
41+
You can also use [Docker Hub](https://hub.docker.com/r/tibiadata/tibiadata-api-go) to pull your images from.
42+
43+
If you want to run the latest code you can switch from _latest_ to _main_.
44+
2945
### Docker-compose
3046

3147
_Information will be added at a later stage._

0 commit comments

Comments
 (0)