diff --git a/README.md b/README.md index 7516e84..ca9e47c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # cringebot `cringebot` is a bot that tracks and auto-deletes on Mastodon/Pleroma accounts according to a set maximum age, if they are bad enough. Tracking multiple instances simultaneously is possible. Once a status is flagged for retention, the bot will not check it again. +*Note: This software is still a little rough around the edges, especially when it comes to first-time setup.* + ## Installation (Linux) #### Obtain root login shell @@ -50,6 +52,23 @@ systemctl status cringebot journalctl -t cringebot -f ``` +#### Learning + +The bot will respond to each of your messages with a categorisation direct message. To adjust it, you can respond to this direct message with: + +``` +learn spam +learn ham + +unlearn spam +unlearn ham + +relearn spam +relearn ham +``` + +Use `learn` on messages the bot is unsure about, `unlearn` to weaken the categorisation, and `relearn` to nudge a clear categorisation one way or another. When a message is learned or relearned as spam, it's scheduled for deletion `max_age` minutes after it was posted. When it's learned or relearned as ham, or unlearned as spam, it's removed from the deletion schedule. + ## Maintainer The maintainer can be contacted at `@thor@pl.thj.no`.