Skip to content

Commit abaa8d5

Browse files
Update README.md
1 parent 7d9e63b commit abaa8d5

1 file changed

Lines changed: 27 additions & 11 deletions

File tree

README.md

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
2-
<a href="https://github.com/KurimuzonAkuma/pyrogram">
3-
<img src="https://raw.githubusercontent.com/KurimuzonAkuma/kurigramartwork/master/kurigram-logo.png" alt="Pyrogram" width="128">
2+
<a href="https://github.com/KurimuzonAkuma/kurigram">
3+
<img src="https://raw.githubusercontent.com/KurimuzonAkuma/kurigramartwork/master/kurigram-logo.png" alt="Kurigram" width="128">
44
</a>
55
<br>
66
<b>Telegram MTProto API Framework for Python</b>
@@ -20,40 +20,55 @@
2020
<a href="https://t.me/kurigram_chat">
2121
Chat
2222
</a>
23+
<br/>
24+
<br/>
25+
<a href="https://pypi.python.org/pypi/kurigram">
26+
<img src="https://img.shields.io/pypi/v/kurigram.svg?logo=pypi&logoColor=white" alt="PyPI package version">
27+
</a>
28+
<a href="https://pypi.python.org/pypi/kurigram">
29+
<img src="https://img.shields.io/pypi/l/kurigram.svg" alt="License">
30+
</a>
31+
<a href="https://pypi.python.org/pypi/kurigram">
32+
<img src="https://img.shields.io/pypi/pyversions/kurigram.svg" alt="Python versions">
33+
</a>
2334
</p>
2435

25-
## Pyrogram
36+
## Kurigram
2637

2738
> Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots
2839
29-
``` python
40+
Kurigram is an actively maintained pyrogram fork for Python designed as a drop-in replacement for Pyrogram, Kurigram provides support for the latest Telegram features including Gifts, Stories, Topics, Business Accounts, and more.
41+
42+
```python
3043
from pyrogram import Client, filters
3144

3245
app = Client("my_account")
3346

3447

3548
@app.on_message(filters.private)
3649
async def hello(client, message):
37-
await message.reply("Hello from Pyrogram!")
50+
await message.reply("Hello from Kurigram!")
3851

3952

4053
app.run()
4154
```
4255

43-
**Pyrogram** is a modern, elegant and asynchronous [MTProto API](https://docs.kurigram.icu/topics/mtproto-vs-botapi)
56+
**Kurigram** is a modern, elegant and asynchronous [MTProto API](https://docs.kurigram.icu/topics/mtproto-vs-botapi)
4457
framework. It enables you to easily interact with the main Telegram API through a user account (custom client) or a bot
4558
identity (bot API alternative) using Python.
4659

4760
### Support
4861

49-
If you'd like to support my fork, you can consider:
62+
Kurigram is an open source project. Your support helps us maintain and improve the library, consider supporting its development:
5063

5164
- `kurimuzonakuma.ton` - TON
5265
- `TYAY3cVST3NY5mqs1M2qGV6PjXDjLLeC6v` - USDT TRC20
5366

67+
Thank you for supporting Kurigram ❤️
68+
5469
### Key Features
5570

56-
- **Ready**: Install Pyrogram with pip and start building your applications right away.
71+
- **Ready**: Install Kurigram with pip and start building your applications right away.
5772
- **Easy**: Makes the Telegram API simple and intuitive, while still allowing advanced usages.
5873
- **Elegant**: Low-level details are abstracted and re-presented in a more convenient way.
5974
- **Fast**: Boosted up by [TgCrypto](https://github.com/pyrogram/tgcrypto), a high-performance cryptography library written in C.
@@ -66,17 +81,18 @@ If you'd like to support my fork, you can consider:
6681
Stable version
6782

6883
``` bash
69-
pip3 install kurigram
84+
pip install kurigram
7085
```
7186

7287
Dev version
88+
7389
``` bash
74-
pip3 install https://github.com/KurimuzonAkuma/kurigram/archive/dev.zip --force-reinstall
90+
pip install https://github.com/KurimuzonAkuma/kurigram/archive/dev.zip --force-reinstall
7591
```
7692

7793
### Resources
7894

79-
- Check out the [docs](https://docs.kurigram.icu) to learn more about Pyrogram, get started right
95+
- Check out the [docs](https://docs.kurigram.icu) to learn more about Kurigram, get started right
8096
away and discover more in-depth material for building your client applications.
8197
- Join the [official channel](https://t.me/kurigram_news) and stay tuned for news, updates and announcements.
8298
- Join the [official chat](https://t.me/kurigram_chat) to communicate with people.

0 commit comments

Comments
 (0)