From 52ca99d9e6b86afb8a4632136aff2e8eb7967041 Mon Sep 17 00:00:00 2001
From: falsycat <me@falsy.cat>
Date: Sat, 4 Mar 2023 20:48:34 +0900
Subject: [PATCH] add README

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a0ee5f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+maidbot
+====
+
+A bot program for fediverse.
+
+
+## CONFIGURATION
+
+Create `config.json` like below.
+
+```json
+{
+  "logging" : "DEBUG",
+  "instance": "falsy.cat",
+  "username": "maidbot",
+  "password": "helloworld",
+  "master"  : "user ID of the master (not username)",
+  "interval": "interval seconds of a single cycle",
+
+  "mods": {
+    "MODNAME": {
+      "key": "param"
+    }
+  }
+}
+```
+
+You can enable a mod by inserting new item to the `mods`.
+
+
+## MODS
+
+I'll add new one when I need.
+
+### elicense
+
+**THIS MOD MAY CAUSE YOU A CANCELLALATION FEE BY UNEXPECTED BEHAVIOUR BUT I DON'T TAKE ANY RESPONSIBILITY**
+
+This mod can make a reservation through elicense.jp.
+
+To enable this mod, insert the below object into the `mods`.
+Now you can say `@maidbot watch 19900101 1 2 3 4` to make a reservation on one of periods from 1 to 4 on 1990/01/01.
+
+```json
+"elicense": {
+  "logging" : "INFO",
+  "school"  : "school ID",
+  "username": "username",
+  "password": "password"
+}
+```
+
+
+## LICENSE
+
+WTFPLv2