Skip to content

Commit 16d3478

Browse files
authored
Update README.md to v1.0.0
1 parent a13996d commit 16d3478

File tree

1 file changed

+12
-28
lines changed

1 file changed

+12
-28
lines changed

README.md

Lines changed: 12 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ Credits to [Mr_Gigabyte](https://github.com/mrgigabyte/proxybot) for additional
2626
* [Contact](#contact)
2727

2828
##ChangeLog!
29+
####Version1.0.0
30+
* **Major Update**: Release, a lot of inline buttons, webhook version
31+
* **Bugs in this version**: Hopefully no
32+
2933
####Version0.4.0
3034
* **Major Update**: Replying behavior and usage changed. [Smart availability feature](#available-and-unavailable-feature).
3135
* **Bugs in this version**:
@@ -71,6 +75,9 @@ Credits to [Mr_Gigabyte](https://github.com/mrgigabyte/proxybot) for additional
7175

7276

7377
## What's new ???
78+
* Webhook version
79+
* Removed all commands except `/start`. All features are now accessible using inline buttons.
80+
* You can now interactively set messages for users. Removed commands like: `/set*message` and `/view*message`
7481
* Added **Reply** button to _usercard_. Now it is the only way to reply back to user. Forwards are gone forever.
7582
* [Smart availability](#available-and-unavailable-feature).
7683
* Due to smart availability: removed commands `/available` or `/unavailable`.
@@ -91,35 +98,21 @@ I've added **Show log** button to _usercard_ which turns _usercard_ into list of
9198

9299
So, to view log:
93100

94-
1. Find user, which log do you want to see, in list of users (`/viewuserlist`) or in list of blocked (`/viewblocklist`)
101+
1. Find user, which log do you want to see, in list of users or in list of blocked
95102
2. Request his _usercard_ by pressing user's inline button.
96103
3. Tap **Show log** button
97104

98105
To view non-text messages tap on `/msgABCDEF` commands which would be placeholders for non-text messages in the list.
99106

100107
To reply back to user, press **Reply** button.
101108

102-
103-
### Setting Start Message
104-
You can set Start Message -- the message, which user sees when he/she starts the bot.
105-
Use `/setstartmessage` command for setting it and `/viewstartmessage` for viewing it.
106-
107-
108109
### Blocking and Unblocking Feature
109110
It was messy and complicated for me in Mr_Gigabyte's implementation, so I've fully rewrited it.
110111

111-
There is a message which I call _usercard_. It has all information about user and an inline keyboard with only one button, which allows to block or unblock user. _Usercard_ can be requested by inline buttons, which could be found in all users list (`/viewuserlist`) and blocked user list (`/viewblocklist`)
112+
There is a message which I call _usercard_. It has all information about user and an inline keyboard with only one button, which allows to block or unblock user. _Usercard_ can be requested by inline buttons, which could be found in all users list and blocked user list.
112113

113114
Data storage moved from couple text files to MongoDB, which will help us to add functionality in future.
114115

115-
So here are the commands connected to blocking:
116-
117-
* `/setblockmessage` <-- To **set the block text** that the user will see once he/she is blocked
118-
* `/viewblockmessage` <-- To **view** your own block message
119-
* `/viewuserlist` <-- To **view** all users in a list
120-
* `/viewblocklist` <-- To **view** blocked users list
121-
122-
123116
### Available and Unavailable Feature
124117
There can be at times when you as an admin are unavailable or don't temporarily have access to the bot, but you at the same time want to notify all the users about your unavailability just like the way we have on answering machines ?
125118

@@ -131,16 +124,9 @@ Your available status is managed automatically. I did this because I always forg
131124

132125
Status is set to **available** each time admin replies to user. After **1 hour** of inactivity it resets back to **unavailable**.
133126
The expiration time is adjustable in config file.
134-
To check the current status simply send **/checkstatus** to the bot
135127

136128
If your status is set to **unavailable** then the bot will send the message to the admin (as usually) and notify the user about the unavailability **( by sending an unavailable message)**
137129

138-
To set the unavailable message simply send:
139-
* `/setunavailablemessage`
140-
141-
To view the unavailable message simply send:
142-
* `/viewunavailablemessage`
143-
144130

145131
## Notes and restrictions
146132
1. Message formatting (both Markdown and HTML) is not supported.
@@ -149,26 +135,24 @@ To view the unavailable message simply send:
149135
4. Supported message types in reply: `text`, `sticker`, `photo`, `video`, `audio`, `voice`, `document`, `location`.
150136
5. To block a user simply tap **Block** button under his _usercard_. It will change its name to **Unblock** and user will be blocked.
151137
6. This bot only works in the private chats.
152-
7. You can use the `/help` command to view all the commands which you can use an admin
153-
154138

155139
## Upcoming Features
156140
* Anti-Spam Feature, limiting messages sent per-second
157141
* Broadcast feature for admins, they can broadcast a certain message to selected users they want
158-
142+
* Markdown support
143+
* Group chats support
144+
* Media support for saved messages
159145

160146
## Remember!
161147
I understand, that "proxy" bots can be used to prevent spammers from being reported, so if you encounter such bots that are used to do "bad" things, feel free to report them: [[email protected]](mailto:[email protected])
162148

163-
164149
## F.A.Q
165150
#### 1. Will this bot work in groups/supergroups/channels?
166151
For the time being this bot just works in private chats.
167152

168153
#### 2. Can I use Emojis in my saved messages (start, block and unavailable)?
169154
Yes! You can use **ONLY** emojis or text in your saved messages, you cannot save stickers/gifs or any other media. Hope that links could help in your particular case.
170155

171-
172156
## Contact
173157
You can contact me via my [Proxy Bot](https://telegram.me/phash_bot)*[]:
174158

0 commit comments

Comments
 (0)