mirror of
https://github.com/miloszowi/everyone-mention-telegram-bot.git
synced 2025-05-20 09:14:07 +00:00
updated README.md
This commit is contained in:
parent
7c355d6cbe
commit
a3254dee45
26
README.md
26
README.md
@ -14,6 +14,8 @@
|
||||
* [`/in`](#in)
|
||||
* [`/out`](#out)
|
||||
* [`/everyone`](#everyone)
|
||||
* [`/groups`](#groups)
|
||||
* [`/silent`](#silent)
|
||||
|
||||
## Getting started
|
||||
|
||||
@ -58,6 +60,11 @@ database.env
|
||||
- `MONDODB_LOG_DIR` - path to logs storage
|
||||
## Commands
|
||||
### `/in`
|
||||
```
|
||||
/in <group_name>
|
||||
```
|
||||
(blank `group_name` will assign you to `default` group)
|
||||
|
||||
Will sign you in for everyone-mentions.
|
||||
|
||||

|
||||
@ -67,6 +74,10 @@ If you have already opted-in before, alternative reply will be displayed.
|
||||

|
||||
|
||||
### `/out`
|
||||
```
|
||||
/out <group_name>
|
||||
```
|
||||
|
||||
Will sign you off for everyone-mentions.
|
||||
|
||||

|
||||
@ -76,11 +87,9 @@ If you haven't opted-in before, alternative reply will be displayed.
|
||||

|
||||
|
||||
### `/everyone`
|
||||
You can also type
|
||||
```
|
||||
/everyone silent
|
||||
/everyone <group_id>
|
||||
```
|
||||
to list users that opted-in for everyone-mentions but without tagging them.
|
||||
Will mention everyone that opted-in for everyone-mentions separated by spaces.
|
||||
|
||||
If user does not have nickname, it will first try to assign his firstname, then random firstname from `names` python library
|
||||
@ -90,3 +99,14 @@ If user does not have nickname, it will first try to assign his firstname, then
|
||||
If there are no users that opted-in for mentioning, alternative reply will be displayed.
|
||||
|
||||

|
||||
|
||||
|
||||
### `/groups`
|
||||
Will display available groups for this chat as well with members count that opted-in for specific group
|
||||
|
||||
### `/silent`
|
||||
```
|
||||
/silent <group_name>
|
||||
```
|
||||
|
||||
Will display all users that opted-in but without notyfing them.
|
Loading…
x
Reference in New Issue
Block a user