summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst27
1 files changed, 27 insertions, 0 deletions
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