From dc01cd95b17d1845b640e319508fa0dbf57b5ea5 Mon Sep 17 00:00:00 2001 From: egor5f421 <130829863+egor5f421@users.noreply.github.com> Date: Wed, 30 Oct 2024 08:02:33 +0300 Subject: [PATCH] Create README.md --- README.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..cbd8815 --- /dev/null +++ b/README.md @@ -0,0 +1,79 @@ +Вот пример документации для вашей библиотеки `Telegram_bots`: + +--- + +**Telegram_bots** + +Библиотека для создания Telegram-ботов на C#. + +--- + +## Описание + +Эта библиотека предоставляет простой и удобный способ создания Telegram-ботов с использованием языка программирования C#. Она позволяет легко обрабатывать обновления от пользователей, отправлять сообщения и работать с клавиатурой. + +--- + +## Установка + +Для установки библиотеки скачайте последний релиз и подключите его к вашему проекту как обычную библиотеку. + +--- + +## Как начать + +Для начала работы создайте экземпляр класса `TelegramBot`, передав ему токен вашего бота: + +```csharp +using TelegramBot bot = new("your_secret_token"); +``` + +Затем добавьте обработчик обновлений: + +```csharp +bot += Update; + +private static async Task Update(Update update, TelegramBot bot) +{ + // Обработка обновлений +} +``` + +--- + +## Отправка сообщений + +Для отправки сообщений используется метод `SendMessage`. Он принимает следующие параметры: + +- `messageText`: Текст сообщения. +- `chatId`: Идентификатор чата. Если не указан, сообщение отправляется в чат, откуда пришло последнее обновление. +- `replyParameters`: Параметры ответа. +- `keyboard`: Клавиатура, которая будет отображаться вместе с сообщением. + +Пример использования: + +```csharp +await bot.SendMessage("Привет!", chatId: 123456789); +``` + +--- + +## Преимущества и отличия + +- Простая интеграция с вашим проектом. +- Удобный синтаксис для обработки обновлений и отправки сообщений. +- Поддержка клавиатуры. + +--- + +## Лицензия + +Этот проект распространяется под лицензией GNU General Public License v3.0. Полную версию лицензии вы можете найти в файле LICENSE. + +--- + +## Примечание + +Остальная документация доступна в релизе. + +---