a little last-minute polish

This commit is contained in:
ari melody 2025-04-14 18:49:04 +01:00
parent cf28e189cd
commit 04dd8e58ba
Signed by: ari
GPG key ID: 60B5F0386E3DDB7E
5 changed files with 44 additions and 7 deletions

13
README.md Normal file
View file

@ -0,0 +1,13 @@
# Crafty McStatusFace
A light application that serves Minecraft server query information in a
convenient format!
## Usage
McStatusFace can be run as a web server with `./mcstatusface serve`. This will
provide server information in JSON format to requests on `GET /?s=<address[:port]>`.
(e.g. `curl -sS "127.0.0.1:8080?s=127.0.0.1:25565" | jq .`)
Alternatively, you can simply run `./mcstatusface <address[:port]>`, and the
tool will provide server details in plain-text format.