a little last-minute polish
This commit is contained in:
parent
cf28e189cd
commit
04dd8e58ba
5 changed files with 44 additions and 7 deletions
13
README.md
Normal file
13
README.md
Normal 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.
|
Loading…
Add table
Add a link
Reference in a new issue