Add readme, switch to yarn

Loathing-Associates-Scripting-Society · Aug 10, 2022 · fe4e4a3 · fe4e4a3
1 parent a7933d4
commit fe4e4a3
Show file tree

Hide file tree

Showing 4 changed files with 200 additions and 503 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# kol-chatbot
+
+A Typescript and Vanilla Node library for creating Kingdom of Loathing chatbots quickly and easily!
+
+To get started quickly, all you need to do is create an instance of KoLBot, giving it the username and password of a literate Kingdom of Loathing account with an associated email address (without these, it is unable to access chat, which somewhat defeats the purpose of a chatbot), then invoke .start on it providing a callback that will be run on incoming kmails, chat messages, and whispers.
+
+Basic usage:
+
+```
+import {KoLBot} from "kol-chatbot";
+
+const chatbot = new KoLBot("username", "P@ssw0rd")
+chatbot.start(console.log)
+```