diff --git a/README.md b/README.md index b411a78..4f1cdac 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,51 @@ -
- - tgram - -

tgram

- Very friendly BOT API library for Python developers. -
- - Channel - - • - - Documentation - - • - - Examples - -
+
tgram

tgram

A user-friendly Telegram Bot API library for Python developers.
ChannelDocumentationExamples

-
- - Supported Bot API version - - - PyPI - - - Downloads - +
Supported Bot API version PyPI Downloads Telegram Channel Telegram Group
- - Telegram Channel - - - Telegram Group - - - Ruff Action Workflow Status - - - Docs Action Workflow Status - - - Release Action Workflow Status - -
- -## Example Usage +## 🚀 Quick Start +Here's a basic example to get started with tgram: ```python from tgram import TgBot, filters from tgram.types import Message -bot = TgBot("TOKEN") +bot = TgBot("YOUR_BOT_TOKEN") @bot.on_message(filters.text & filters.private) async def on_message(bot: TgBot, message: Message) -> Message: - #Echo + # Echo the incoming message return await message.reply_text( message.text, - entities=message.entities) + entities=message.entities + ) -bot.run_for_updates() +bot.run() ``` -## Features -- Smart plugins with auto-load. -- Filters for handlers. -- Bound methods for update types. - -## Requirements -- Python 3.8 or higher. -- A [Telegram BOT Token](https://core.telegram.org/bots/tutorial#obtain-your-bot-token). +## 📦 Features +- **Smart Plugins**: Auto-loadable plugins for modular development. +- **Filters for Handlers**: Simplify event handling with filters. +- **Bound Methods**: Access bound methods for different update types easily. -## How to install? -Here's how to install the tgram library. The commands are given below: +## 📚 Documentation +Full documentation is available [here](https://z44d.github.io/tgram/). -``` bash -# With Git +## 🔧 Installation +You can install the tgram library using one of the following methods: +### Via git: +```bash pip install git+https://github.com/z44d/tgram -U - -# With PyPi (Recommended) +``` +### Via PyPI (Recommended) +```bash pip install tgram -U ``` -## Help & Support +## 💡 Requirements +- **Python**: Version 3.8 or higher. +- **Telegram Bot Token**: Obtain one by following [this guide](https://core.telegram.org/bots/tutorial#obtain-your-bot-token). -- Join our [Telegram chat](https://t.me/tgbot_chat). +## 💬 Help & Support +- For general questions and help, join our **[Telegram chat](https://t.me/tgbot_chat)**. +- Follow updates via the **[Telegram Channel](https://t.me/tgbot_channel)**. \ No newline at end of file