Update README

master
Thor 3 years ago
parent 410a578bce
commit e1f42cc269
  1. 4
      README.md

@ -1,5 +1,5 @@
# cringebot
`cringebot` is a bot that tracks and auto-deletes on Mastodon/Pleroma accounts according to a set maximum age, if they are cringe enough. Tracking multiple accounts simultaneously is possible. Once a status is flagged as based, the bot will not touch it.
`cringebot` is a bot that tracks and auto-deletes statuses on Mastodon/Pleroma accounts after a set time if they are cringe enough. Multiple accounts across multiple instances are supported.
## Installation (Ubuntu Linux)
@ -51,7 +51,7 @@ journalctl -t cringebot -f
#### Learning
The bot will respond to each of your statuses with a categorisation status. Reply with `cringe` and `based` to teach the bot a categorisation, and `unlearn` to undo it. When the bot categorises or is taught that a message is cringe, it's scheduled for deletion `max_age` minutes after it was posted. When it's learned as based, or unlearned, it's removed from the deletion schedule.
The bot will respond to each of your statuses with a categorisation status. Reply with `cringe` and `based` to teach the bot a categorisation, and `unlearn` to undo it. When the bot categorises or is taught that a message is cringe, it's scheduled for deletion `max_age` minutes after it was posted. When it's learned as based, or unlearned, it's removed from the deletion schedule. Some learning parameters can be tuned by changing the constants in `bogofilter.py`. These will eventually be tunable in `config.toml`.
## Maintainer

Loading…
Cancel
Save