Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
egor5f421 authored Oct 30, 2024
1 parent 3cf40b6 commit dc01cd9
Showing 1 changed file with 79 additions and 0 deletions.
79 changes: 79 additions & 0 deletions README.md
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.

---

## Примечание

Остальная документация доступна в релизе.

---

0 comments on commit dc01cd9

Please sign in to comment.