From 83f5fd1cd1b176eebbf2850c10494872e75d0397 Mon Sep 17 00:00:00 2001
From: onyx-and-iris <code@onyxandiris.online>
Date: Sat, 21 Mar 2026 00:32:44 +0000
Subject: [PATCH] upd README

---
 README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 46 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index e0fdd8b..45e1f5e 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,9 @@
 # q3rcon-cli
 
-[![PyPI - Version](https://img.shields.io/pypi/v/q3rcon-cli.svg)](https://pypi.org/project/q3rcon-cli)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/q3rcon-cli.svg)](https://pypi.org/project/q3rcon-cli)
+[![Hatch project](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pypa/hatch/master/docs/assets/badge/v0.json)](https://github.com/pypa/hatch)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![PyPI - Version](https://img.shields.io/pypi/v/q3rcon-tui.svg)](https://pypi.org/project/q3rcon-tui)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/q3rcon-tui.svg)](https://pypi.org/project/q3rcon-tui)
 
 -----
 
@@ -12,10 +14,51 @@
 
 ## Installation
 
+*with uv*
+
 ```console
-pip install q3rcon-cli
+uv tool install q3rcon-cli
 ```
 
+*with pipx*
+
+```console
+pipx install q3rcon-cli
+```
+
+The CLI should now be discoverable as q3rcon-cli.
+
+## Configuration
+
+#### Flags
+
+Pass `--host`, `--port` and `--password` as flags:
+
+```console
+q3rcon-cli --host=localhost --port=28960 --password=rconpassword
+```
+
+Additional Flags:
+
+-   `--interactive`: Boolean flag, enable REPL mode.
+
+#### Environment Variables
+
+example .envrc:
+
+```env
+#!/usr/bin/env bash
+
+export Q3RCON_CLI_HOST="localhost"
+export Q3RCON_CLI_PORT="28960"
+export Q3RCON_CLI_PASSWORD="<rcon password>"
+```
+
+## Special Thanks
+
+- [lapetus-11](https://github.com/Iapetus-11) for writing the [aio-q3-rcon](https://github.com/Iapetus-11/aio-q3-rcon) package.
+- [Daniel Melchor](https://github.com/danimelchor) for creating the wonderful [clypi](https://github.com/danimelchor/clypi) library.
+
 ## License
 
 `q3rcon-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.