diff --git a/README.md b/README.md index 064db03..cd00b09 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ This is the source code for the API of the [mcstatus.io](https://mcstatus.io) website (`api.mcstatus.io`). This API server is built using [Go](https://go.dev) with [Fiber](https://docs.gofiber.io/) as the HTTP server of choice. This uses a custom Minecraft utility library found in the [mcstatus-io/mcutil](https://github.com/mcstatus-io/mcutil) repository. You are free to modify and host your own copy of this server as long as the [license](https://github.com/mcstatus-io/ping-server/blob/main/LICENSE) permits. If you do not wish to self host, we host a public and free-to-use copy which you may learn more about by visiting the [official API documentation](https://mcstatus.io/docs). +Please note that while this repository may seem to conform to some versioning standard, it most certainly does not. Updates are pushed at random, with no semantic versioning in place. Any update (also known as a *commit*) may suddenly break existing configurations without notice or warranty. If you run a privately hosted ping server, please refer to the updated example configuration file before attempting to update to the latest commit. + ## API Documentation https://mcstatus.io/docs