From 89e26ae71ce8d27f9bb6836ae84fee0749acb079 Mon Sep 17 00:00:00 2001 From: zekroTJA Date: Thu, 21 Mar 2024 00:20:51 +0100 Subject: [PATCH] update readme --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 33e3c3f..f3477b9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # rconcli -A little CLI to issue RCON commands to a Minecraft server. \ No newline at end of file +A little CLI to issue RCON commands to a Minecraft server. + +![WindowsTerminal_ClQRborIho](https://github.com/zekroTJA/rconcli/assets/16734205/7a0ee0e5-0627-4f35-bcc6-1c34dbd07722) + +## Usage + +``` +$ rconcli --help +A simple RCON CLI for Minecraft servers. + +Usage: rconcli.exe [OPTIONS] [COMMAND]... + +Arguments: + [COMMAND]... Command to execute + +Options: + --properties Location of a server.proterties file to read credentials from + -a, --address
The address and port of the target server + -p, --password The password of the target server + --no-color Supress colored output + -h, --help Print help + -V, --version Print version +``` \ No newline at end of file