add README

This commit is contained in:
falsycat 2023-03-04 20:48:34 +09:00
parent 631929acdb
commit 52ca99d9e6

56
README.md Normal file
View File

@ -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