Skip to content

Commit 3573d53

Browse files
authored
Update README.md (#5)
* Update README.md - adding docker-compose example - adding deployment note - link to license and cipsoft.com
1 parent 57769dd commit 3573d53

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Current status of v3 is in beta and information like documentation can be found
1717
- [Docker-compose](#docker-compose)
1818
- [Local development](#local-development)
1919
- [Environment variables](#environment-variables)
20+
- [Deployment note](#deployment-note)
2021
- [API documentation](#api-documentation)
2122
- [Available endpoints](#available-endpoints)
2223
- [General information](#general-information)
@@ -44,7 +45,20 @@ If you want to run the latest code you can switch from _latest_ to _main_.
4445

4546
### Docker-compose
4647

47-
_Information will be added at a later stage._
48+
This is a simple example on how you can get up and running with TibiaData in docker-compose, which will be running on port 8080 and be exposed locally.
49+
50+
```yaml
51+
version: "3"
52+
53+
services:
54+
tibiadata:
55+
image: ghcr.io/tibiadata/tibiadata-api-go:latest
56+
restart: always
57+
environment:
58+
- TIBIADATA_UA_HOSTNAME=tibiadata.example.com
59+
ports:
60+
- 8080:8080
61+
```
4862
4963
### Local development
5064
@@ -64,6 +78,12 @@ docker run -p 127.0.0.1:80:8080/tcp --rm -it tibiadata
6478

6579
_Information will be added at a later stage._
6680

81+
### Deployment note
82+
83+
You should consider to add a layer in front of this application, so you can do caching of endpoints, access controll or what ever your needs are.
84+
85+
We do so at least by using [Kong](https://github.com/Kong/kong) API Gateway, which solves features like caching, rate-limiting, authentication and more.
86+
6787
## API documentation
6888

6989
Current status of v3 is in beta and information like documentation can be found on [tibiadata.com](https://tibiadata.com/doc-api-v3/v3-beta/).
@@ -93,9 +113,9 @@ Those are the current existing endpoints.
93113

94114
## General information
95115

96-
Tibia is a registered trademark of CipSoft GmbH. Tibia and all products related to Tibia are copyright by CipSoft GmbH.
116+
Tibia is a registered trademark of [CipSoft GmbH](https://www.cipsoft.com/en/). Tibia and all products related to Tibia are copyright by [CipSoft GmbH](https://www.cipsoft.com/en/).
97117

98118
## Credits
99119

100-
- Authors: Tobias Lindberg – [List of contributors](https://github.com/tibiadata/tibiadata-api-go/graphs/contributors)
101-
- Distributed under MIT License
120+
- Authors: [Tobias Lindberg](https://github.com/tobiasehlert)[List of contributors](https://github.com/TibiaData/tibiadata-api-go/graphs/contributors)
121+
- Distributed under [MIT License](LICENSE)

0 commit comments

Comments
 (0)