update readme
This commit is contained in:
parent
ab6d0a93f8
commit
ad7164edb7
34
README.md
34
README.md
@ -1,3 +1,35 @@
|
||||
# chatterbot
|
||||
|
||||
an irc bot designed to bring new users into more obscure channels
|
||||
### this bot and intended designs goals are changing rapidly as of now
|
||||
|
||||
this is an irc bot helping to kickstart the growth of new channels on
|
||||
tilde.town. it will do so by sending reminders to the main chat when selected
|
||||
low activity channels have new activity. the bot can be manually invited to
|
||||
channels that you wish to draw attention to, and a (couple) condition(s) (??
|
||||
still debating) need to be met in order for it to send a reminder to the main
|
||||
chat (as of now):
|
||||
|
||||
* at least 24 hours has passed since the last time the bot sent a message to #tildetown
|
||||
* (??) less than 50 messages have been sent in the channel within that period
|
||||
|
||||
## Commands
|
||||
|
||||
### !chatterbot invite
|
||||
|
||||
invite the bot to new channels. one or more channels may be specified.
|
||||
>!chatterbot ivite #rocketry
|
||||
>!chatterbot invite #halo #fortnite #minecraft
|
||||
|
||||
### !chatterbot kick
|
||||
|
||||
kick the bot out of the current channel if none are specified, or list one or
|
||||
more channels for removal.
|
||||
>!chatterbot kick
|
||||
>!chatterbot kick #fortnite
|
||||
>!chatterbot kick #halo #minecraft
|
||||
|
||||
## How to block this bot in your irc client
|
||||
|
||||
dont like seeing the messages? your client can be configured to ignore messages from this bot
|
||||
|
||||
#### TODO: write this part
|
Loading…
x
Reference in New Issue
Block a user