Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
z44d committed Jun 26, 2024
1 parent 86fc846 commit abf5526
Showing 1 changed file with 53 additions and 1 deletion.
54 changes: 53 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,53 @@
## Soon.
<img src="https://raw.githubusercontent.com/7n2/nothing/main/tgbot.jpg" alt="tgram" />
<p align="center">
<b>A Very friendly BOT API library for python devs.</b>
<br>
<a href="https://t.me/tgbot_channel">
Channel
</a>
<a href="https://t.me/tgbot_chat">
Chat
</a>
</p>

# tgram [![PyPI](https://img.shields.io/pypi/v/tgram.svg?logo=python&logoColor=%23959DA5&label=pypi&labelColor=%23282f37)](https://pypi.org/project/tgram/) [![Downloads](https://static.pepy.tech/badge/tgram)](https://pepy.tech/project/tgram)

#### Example Usage
```python
from tgram import TgBot, filters
from tgram.types import Message

bot = TgBot("TOKEN")

@bot.on_message(filters.text)
async def on_message(bot: TgBot, message: Message) -> Message:
#Echo
return await bot.send_message(
message.chat.id,
message.text,
entities=message.entities
)
```

## TODO
- Bound methods for types.
- Smart plugins with auto load.

## Requirements
- Python 3.8 or higher.
- A [Telegram BOT Token](https://core.telegram.org/bots/tutorial#obtain-your-bot-token).

## How to install?
Here's how to install the tgram lib, the commands are given below:

``` bash
# With Git
pip install git+https://github.com/2ei/tgram -U

# With PyPi (Recommended)
pip install tgram -U
```

## LICENSE
[MIT](https://github.com/2ei/tgram?tab=MIT-1-ov-file)

0 comments on commit abf5526

Please sign in to comment.