From 90a0e7bb34c6fb7aeffb4971a5c16124c6be6522 Mon Sep 17 00:00:00 2001
From: meliurwen <meliurwen@gmail.com>
Date: Tue, 28 Dec 2021 15:12:52 +0100
Subject: [PATCH] Added README with a list of commands

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f3407e9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# Catbox IRCD
+
+A dockerized version of catbox IRCD.
+
+> ⚠️ **Warning:** despite being bare bones in terms of functionalities, some
+> questionable design and code quality choices has been taken; the reason is
+> because `Catbox` is born as a personal challenge and to fulfill the original
+> dev's need.
+
+> This makes this app quite unsuitable for use cases where it needs to be
+> exposed to an uncontrolled newtork (the internet) and moderation is needed.
+
+## Supported commands
+
+An (incomplete) list of supported commands found [here](https://github.com/horgh/catbox/blob/07cbec85ee9f733b3eb74d2a5bf4120c66d701f2/local_server.go):
+
+```txt
+PING
+PONG
+ERROR
+UID
+NOTICE
+SID
+SJOIN
+TB
+JOIN
+NICK
+PART
+WALLOPS
+OPERWALL
+QUIT
+MODE
+TOPIC
+SQUIT
+KILL
+ENCAP
+WHOIS
+CLICONN
+AWAY
+INVITE
+TMODE
+KLINE
+UNKLINE
+GCAP
+```