From 74f17b90ff79f4e9b08243d135f94798cc35f0f2 Mon Sep 17 00:00:00 2001
From: tcsenpai <dev@tcsenpai.com>
Date: Wed, 19 Feb 2025 11:47:13 +0100
Subject: [PATCH] added hosted details

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++------
 1 file changed, 37 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 83aa637..4bef814 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,10 @@
 
 A lightweight telnet chat server designed with retro computers in mind. Perfect for your Commodore 64, ZX Spectrum, Amiga, or any other vintage computer with telnet capabilities!
 
+Hosted instance: [discus.sh:2323](telnet://discus.sh:2323)
+
+Connect using any telnet client (e.g. `telnet discus.sh 2323` or `atdt discus.sh:2323`)
+
 ## Features
 
 - Multi-room chat system
@@ -35,22 +39,49 @@ This is a fun project for retro computing enthusiasts. Please note:
 
 ## Getting Started
 
-1. Install Python 3.6 or higher
-2. Run the server: python main.py
+1. Install Python 3.6 or higher and the dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+2. Run the server:
+
+```bash
+python main.py
+```
+
 3. Connect using any telnet client
 4. Default admin credentials: admin/admin (change these!)
 
 ## Commands
 
-Basic commands:
+Basic commands (available to all, including guests):
 
 - /help - Show available commands
 - /login - Log into your account
 - /register - Create new account
-- /rooms - List chat rooms
-- /join - Enter a chat room
+- /whoami - Show current username
+- /quit - Disconnect from server
 
-Admin commands available after login with admin privileges.
+Authenticated user commands:
+
+- /rooms - List available chat rooms
+- /join - Enter a chat room
+- /users - List online users
+- /broadcast - Send message to all users
+- /passwd - Change your password
+
+Admin commands:
+
+- /op - Give admin privileges to user
+- /deop - Remove admin privileges from user
+- /kick - Disconnect a user from the server
+- /ban - Ban a username from the server
+- /createroom - Create a new chat room
+
+Note: Admin commands are only available after logging in with admin privileges.
+Messages are sent by simply typing without any command prefix.
 
 ## Community