From 56a3acd8f5b6928071ed64604eabc3d382e1c25a Mon Sep 17 00:00:00 2001
From: Maksim Pischulenok <41614960+pischule@users.noreply.github.com>
Date: Sat, 17 Jun 2023 18:24:16 +0300
Subject: [PATCH] Update README.md

---
 README.md | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 80378cb..e4a8045 100644
--- a/README.md
+++ b/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
-```
\ No newline at end of file
+```