From: John Runyon <redacted>
Date: Mon, 4 Sep 2023 03:45:07 +0000 (-0600)
Subject: update README
X-Git-Url: https://jfr.im/git/erebus.git/commitdiff_plain/e2035cb8c6f8a0730673baebc7881db563f0eb67

update README
---

diff --git a/README.md b/README.md
index afe94fd..521314d 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@ Getting started
 - `vim bot.config`
 - Create a MySQL database, i.e. `CREATE DATABASE foo; GRANT ALL ON foo.* TO ...`
 - `mysql <dump.sql`
+- Add your auth (main NickServ nick/account name on other networks) in the database as owner: `INSERT INTO users VALUES ('YourAuth', 100);`
 - `./run`
 
 Install croncheck.sh in your crontab, if desired.  
@@ -32,12 +33,20 @@ Buffering
 ---------
 The bot includes message buffering, with two different message queues (plus a "fast" message which sends immediately). This is to help prevent the bot from being flooded off the network by malicious users.
 
-Unfortunately this does mean that the bot can be overwhelmed and take quite a while to respond. As an admin, you can use the QCLEAR command to clear the queues. If you control the IRC server, you can exempt the bot from flooding checks and then set `[erebus] nofakelag = 1` in the bot.config. This will turn off message buffering completely.
+Unfortunately this does mean that the bot can be overwhelmed and take quite a while to respond. As an admin, you can use the `!QCLEAR` command to clear the queues. If you control the IRC server, you can exempt the bot from flooding checks and then set `[erebus] nofakelag = 1` in the bot.config. This will turn off message buffering completely.
+
+
+Using the bot
+-------------
+Commands can be triggered by:
+- Messaging the bot (`/msg Erebus whoami`)
+- Prefixing the command with the bot's name and a colon (`/msg #channel Erebus: whoami`)
+- Or prefixing the command with the trigger character set in bot.config (`/msg #channel !whoami` if `[erebus] trigger = !`)
 
 
 Online Help
 -----------
-A command listing, with most (but not all) of the standard modules, is available at https://jfr.im/help/
+A command listing, with most (but not all) of the standard modules, is available at [https://jfr.im/help/](https://jfr.im/help/).
 
 So long as you don't prohibit loading of the help module with `[autoloads] help = 0`, command info will be available with `!HELP <command>`
 
@@ -46,7 +55,7 @@ However, due to the message buffering mentioned above, there is no command listi
 1. Set `[help] url` in the config file to a path where help can be found, f.e. `[help] url = https://jfr.im/help/%d.txt`. %d (or %s) will be replaced with the user's level. This determines the URL which is provided to users when they !SHOWCOMMANDS
 1. Run `!GENHELP` whenever you change which modules (or commands) are available, or else just set `[help] autogen = 1`.
 
-(With nofakelag = 1, !SHOWCOMMANDS will spam the user with the whole list of commands.)
+(With `nofakelag = 1`, `!SHOWCOMMANDS` will spam the user with the whole list of commands.)
 
 
 Support