From d2fb78108ee13ec13153d898a40d8c6471203df1 Mon Sep 17 00:00:00 2001 From: ari melody Date: Mon, 16 Jun 2025 19:30:51 +0100 Subject: [PATCH] update readme --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9745dbb..10e2605 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,14 @@ For more information, see https://minecraft.wiki/w/Query ## 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=`. -(e.g. `curl -sS "127.0.0.1:8080?s=127.0.0.1:25565" | jq .`) +McStatusFace can simply be run with `mcstatusface `. -Alternatively, you can simply run `mcstatusface `, and the +Alternatively, you can start a web interface with +`mcstatusface serve [address:[port]]`. + +This provides a web interface to query server information via a frontend, or +in JSON format if the request is cURLed. + +The server queries Minecraft servers when a `GET /?s=` request +is received. (e.g. `curl -sS "127.0.0.1:8080?s=127.0.0.1:25565" | jq .`) tool will provide server details in plain-text format.