Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
z44d committed Oct 4, 2024
1 parent 24b9bf8 commit 9e31806
Showing 1 changed file with 28 additions and 67 deletions.
95 changes: 28 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,90 +1,51 @@
<div align="center">
<a href="https://github.com/z44d/tgram">
<img src="https://github.com/user-attachments/assets/ad99412f-8d69-446c-bedf-5b7663f69727" alt="tgram" width="128">
</a>
<h1>tgram</h1>
<b>Very friendly BOT API library for Python developers.</b>
</br>
<a href="https://t.me/tgbot_channel">
Channel
</a>
<a href="https://z44d.github.io/tgram/">
Documentation
</a>
<a href="https://github.com/z44d/tgram/tree/main/examples">
Examples
</a>
</div>
<div align="center"> <a href="https://github.com/z44d/tgram"> <img src="https://github.com/user-attachments/assets/ad99412f-8d69-446c-bedf-5b7663f69727" alt="tgram" width="128"> </a> <h1>tgram</h1> <b>A user-friendly Telegram Bot API library for Python developers.</b> <br> <a href="https://t.me/tgbot_channel">Channel</a> • <a href="https://z44d.github.io/tgram/">Documentation</a> • <a href="https://github.com/z44d/tgram/tree/main/examples">Examples</a> </div>

<br>

<div align="center">
<a href="https://core.telegram.org/bots/api-changelog#september-6-2024">
<img src="https://img.shields.io/badge/Bot%20API-7.10-blue?logo=telegram" alt="Supported Bot API version">
</a>
<a href="https://pypi.org/project/tgram/">
<img src="https://img.shields.io/pypi/v/tgram.svg?logo=python&logoColor=%23959DA5&label=pypi&labelColor=%23282f37" alt="PyPI">
</a>
<a href="https://pepy.tech/project/tgram">
<img src="https://static.pepy.tech/badge/tgram" alt="Downloads">
</a>
<div align="center"> <a href="https://core.telegram.org/bots/api-changelog#september-6-2024"> <img src="https://img.shields.io/badge/Bot%20API-7.10-blue?logo=telegram" alt="Supported Bot API version"> </a> <a href="https://pypi.org/project/tgram/"> <img src="https://img.shields.io/pypi/v/tgram.svg?logo=python&logoColor=%23959DA5&label=pypi&labelColor=%23282f37" alt="PyPI"> </a> <a href="https://pepy.tech/project/tgram"> <img src="https://static.pepy.tech/badge/tgram" alt="Downloads"> </a> <a href="https://t.me/tgbot_channel"> <img src="https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram" alt="Telegram Channel"> </a> <a href="https://t.me/tgbot_chat"> <img src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" alt="Telegram Group"> </a> </div>

<a href="https://t.me/tgbot_channel">
<img src="https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram" alt="Telegram Channel">
</a>
<a href="https://t.me/tgbot_chat">
<img src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" alt="Telegram Group">
</a>
<a href="https://github.com/z44d/tgram/actions/workflows/ruff.yml">
<img src="https://img.shields.io/github/actions/workflow/status/z44d/tgram/ruff.yml?style=flat&label=Ruff" alt="Ruff Action Workflow Status">
</a>
<a href="https://github.com/z44d/tgram/actions/workflows/build-docs.yml">
<img src="https://img.shields.io/github/actions/workflow/status/z44d/tgram/build-docs.yml?style=flat&label=Docs" alt="Docs Action Workflow Status">
</a>
<a href="https://github.com/z44d/tgram/actions/workflows/release.yml">
<img src="https://img.shields.io/github/actions/workflow/status/z44d/tgram/release.yml?style=flat&label=Release" alt="Release Action Workflow Status">
</a>
</div>

## 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)**.

0 comments on commit 9e31806

Please sign in to comment.