From 3c245e81160dd437e0ce8c44e26490e06ac36859 Mon Sep 17 00:00:00 2001
From: Artem Vasilev <kern.usr@gmial.com>
Date: Fri, 1 Mar 2024 02:06:08 +0300
Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=BF=D0=B8=D1=81=D0=B0=D0=BB=20RE?=
 =?UTF-8?q?ADME.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3cb3c0c..e976331 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,44 @@
-# tbc-get-id
\ No newline at end of file
+# Telegram Bot Command - Get user and chanel id
+
+Implements the ability to get a user or channel ID in Telegram.
+
+Реализует возможность получить ID пользователя или канала в Telegram.
+
+## Подключение к проекту
+
+Установите пакет в зависимости
+
+```shell
+composer require webmasterskaya/tbc-get-id
+```
+
+Зарегистрируйте класс команды, при инициализации приложения.
+
+```php
+$bot_api_key  = 'your:bot_api_key';
+$bot_username = 'username_bot';
+
+$telegram = new Longman\TelegramBot\Telegram($bot_api_key, $bot_username);
+
+$telegram->addCommandClass(\Webmasterskaya\TelegramBotCommands\Commands\UserCommands\IdCommand::class);
+
+$telegram->handle();
+// OR
+$telegram->handleGetUpdates();
+```
+
+Команду можно запускать вручную, без изменений входящих данных!
+
+```php
+$telegram->executeCommand('id');
+```
+
+## Использование
+
+### В чатах
+1. Выполните команду `/id`, чтобы получить ID текущего чата.
+2. Выполните команду `/id` в ответ на любое сообщение и вы получите ID текущего чата, ID автора сообщения и ID чата, из которого это сообщение переслали.
+
+### В личных сообщениях
+1. Выполните команду `/id`, чтобы получить ваш ID.
+2. Перешлите любое сообщение (пользователя, чата, канала или другого бота) боту и, в ответ на это сообщение, выполните команду `/id`.
\ No newline at end of file