From 5039d0b51be13b2d2e8ed1c2e797eb4f6d281114 Mon Sep 17 00:00:00 2001
From: Pratyush Desai
Date: Fri, 20 Aug 2021 17:14:44 +0530
Subject: switch to rst, add setvhost, use config vars

---
 README.rst | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.rst

(limited to 'README.rst')

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..7bb4c6a
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,27 @@
+SnoParser
+=========
+
+Parses the Server Notices from ErgoIRCd.
+
+
+Assumptions
+-----------
+
+- ``force-nick-equals-account=True``
+- The Bot needs to be oper and have all the snomasks.
+
+Current Coverage
+----------------
+
+1. CONNECT
+2. XLINE
+3. NICK
+4. KILL
+5. ACCOUNT (reg only)
+
+Configurations
+--------------
+
+1. Formatting for 'AutoVhost' post Registration (TODO: Disable)
+2. Configure the '#channel' to send the SNO lines (disabled by default) (TODO: Add Exceptions)
+3. Use ZWSP to toggle nickhighlights when in channel.
\ No newline at end of file
-- 
cgit v1.2.3