From aaf129b7ba70b79714e7d1dffbccc83e72b2a189 Mon Sep 17 00:00:00 2001
From: Pinapelz <yukais@pinapelz.com>
Date: Mon, 22 Jun 2026 21:39:55 -0700
Subject: Update README.md

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index aba85b2..6d5248e 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
 # Teamspeak 6 Web Server Status
+A simple webview of your Teamspeak 6 Server. This is a Python re-write of [ts6-web-explorer](https://github.com/Guraz/ts6-web-explorer) along with a visual overhaul 
+
+<img width="852" height="906" alt="image" src="https://github.com/user-attachments/assets/00cf9ea7-cfad-4633-8d3b-7a66039fb87b" />
+
+# Notes
+```
+uv sync
+uv run app.py
+```
+- Rename `.env.template` to `.env` and fill in the parameters as required
+- Spacer channels are hidden
+- Channels with the text `AFK` are shown, the number of users in this channel is used as the AFK users indicator
+- Edit and configure `config.py` for all other non-essential settings
-- 
cgit v1.2.3