mirror of
https://github.com/pischule/go-mention-all-bot.git
synced 2025-12-19 06:56:43 +00:00
Update README.md
This commit is contained in:
committed by
GitHub
parent
f9957a313b
commit
56a3acd8f5
26
README.md
26
README.md
@@ -1,8 +1,30 @@
|
||||
# 🦄 go-mention-bot
|
||||
|
||||
Telegram bot that helps to mention all users in a group.
|
||||
Second version of [mention-all-the-bot](https://github.com/pischule/mention-all-bot)
|
||||
|
||||
## how to run this
|
||||
## Usage
|
||||
|
||||
1. Use [hosted](https://t.me/mention_all_the_bot?startgroup) or host yourself
|
||||
|
||||
1. Add to your group
|
||||
|
||||
1. Everyone who wants to receive notifications opts-in using /in
|
||||
|
||||
1. Now you can call everyone with /all
|
||||
|
||||
Commands:
|
||||
|
||||
```
|
||||
/start - Display help text
|
||||
/in - Opt-in to receive mentions
|
||||
/out - Opt-out of receiving mentions
|
||||
/all - Mention all opted-in users
|
||||
/stats - Display bot stats
|
||||
/cleanup - Manually opt-out left members of the group
|
||||
```
|
||||
|
||||
## How to run this
|
||||
|
||||
```shell
|
||||
$ cat << EOF > docker-compose.yml
|
||||
@@ -16,4 +38,4 @@ services:
|
||||
TELEGRAM_TOKEN: "<your-bot-token>"
|
||||
EOF
|
||||
$ docker compose up -d
|
||||
```
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user