aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorluk3yx <luk3yx@users.noreply.github.com>2022-05-06 13:34:34 +1200
committerluk3yx <luk3yx@users.noreply.github.com>2022-05-06 13:34:34 +1200
commit41ea6666a4f741bf9f1f6e7781f34be68a7b93ea (patch)
tree441bebe27250dc3fcedaffa833408c26ea3e0656
parentf24866313893719059aa483953ec60ee58abb0f8 (diff)
downloadlurklite-commands-41ea6666a4f741bf9f1f6e7781f34be68a7b93ea.tar.gz
lurklite-commands-41ea6666a4f741bf9f1f6e7781f34be68a7b93ea.zip
Add "how to use"
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 23501ac..acacfb1 100644
--- a/README.md
+++ b/README.md
@@ -4,3 +4,13 @@ The code for some of the commands used by the "official" lurklite bot is
published here.
Note that there are a few different licenses used across all the files.
+
+## How to use
+
+Add the following to the `[core]` section of your lurklite config file:
+
+```
+custom_cmds = /path/to/lurklite-commands
+```
+
+And restart your bot.