-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
79 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
||
--- | ||
|
||
## Примечание | ||
|
||
Остальная документация доступна в релизе. | ||
|
||
--- |