You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-4Lines changed: 24 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,7 @@ Current status of v3 is in beta and information like documentation can be found
17
17
-[Docker-compose](#docker-compose)
18
18
-[Local development](#local-development)
19
19
-[Environment variables](#environment-variables)
20
+
-[Deployment note](#deployment-note)
20
21
-[API documentation](#api-documentation)
21
22
-[Available endpoints](#available-endpoints)
22
23
-[General information](#general-information)
@@ -44,7 +45,20 @@ If you want to run the latest code you can switch from _latest_ to _main_.
44
45
45
46
### Docker-compose
46
47
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.
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
+
67
87
## API documentation
68
88
69
89
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.
93
113
94
114
## General information
95
115
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/).
97
117
98
118
## Credits
99
119
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)
0 commit comments