ari/mcstatusface
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

improve runtime docs

Browse source
This commit is contained in:
ari melody 2025-04-14 23:53:03 +01:00
parent 04dd8e58ba
commit bac3204572
Signed by: ari
GPG key ID: 60B5F0386E3DDB7E
4 changed files with 14 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -5,9 +5,9 @@ convenient format!
## Usage
McStatusFace can be run as a web server with `./mcstatusface serve`. This will
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
Alternatively, you can simply run `mcstatusface <address[:port]>`, and the
tool will provide server details in plain-text format.