mirror of
https://github.com/TeamPGM/pyrogram.git
synced 2024-11-24 15:59:18 +00:00
Update README.rst
This commit is contained in:
parent
1db1339de8
commit
ab2f684565
32
README.rst
32
README.rst
@ -3,7 +3,7 @@
|
|||||||
Table of Contents
|
Table of Contents
|
||||||
=================
|
=================
|
||||||
|
|
||||||
- `Overview`_
|
- `About`_
|
||||||
|
|
||||||
- `Features`_
|
- `Features`_
|
||||||
|
|
||||||
@ -26,8 +26,8 @@ Table of Contents
|
|||||||
- `License`_
|
- `License`_
|
||||||
|
|
||||||
|
|
||||||
Overview
|
About
|
||||||
========
|
=====
|
||||||
|
|
||||||
**Pyrogram** is a fully functional Telegram Client Library written from the ground up in Python.
|
**Pyrogram** is a fully functional Telegram Client Library written from the ground up in Python.
|
||||||
It offers simple and complete access to the `Telegram Messenger API`_ and is designed for Python
|
It offers simple and complete access to the `Telegram Messenger API`_ and is designed for Python
|
||||||
@ -37,7 +37,7 @@ developers keen on building custom Telegram applications.
|
|||||||
Features
|
Features
|
||||||
--------
|
--------
|
||||||
|
|
||||||
- **Easy to setup**: Pyrogram can be easily installed and upgraded using ``pip``, requires
|
- **Easy to setup**: Pyrogram can be easily installed and upgraded using **pip**, requires
|
||||||
a minimal set of dependencies (which are also automatically managed) and very few lines
|
a minimal set of dependencies (which are also automatically managed) and very few lines
|
||||||
of code to get started with.
|
of code to get started with.
|
||||||
|
|
||||||
@ -49,6 +49,9 @@ Features
|
|||||||
`MTProto Mobile Protocol v2.0`_ and the mechanisms needed for establishing
|
`MTProto Mobile Protocol v2.0`_ and the mechanisms needed for establishing
|
||||||
a reliable connection.
|
a reliable connection.
|
||||||
|
|
||||||
|
- **Fast**: Pyrogram's speed is boosted up by `TgCrypto`_, a high-performance, easy-to-install
|
||||||
|
Telegram Crypto Library written in C as a Python extension.
|
||||||
|
|
||||||
- **Updated**: Pyrogram makes use of the latest Telegram API version, currently `Layer 75`_.
|
- **Updated**: Pyrogram makes use of the latest Telegram API version, currently `Layer 75`_.
|
||||||
|
|
||||||
- **Documented**: Pyrogram API public methods are documented and resemble the well
|
- **Documented**: Pyrogram API public methods are documented and resemble the well
|
||||||
@ -93,7 +96,7 @@ Configuration
|
|||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
|
|
||||||
- And here's how Pyrogram looks:
|
- And here's how Pyrogram looks like:
|
||||||
|
|
||||||
.. code:: python
|
.. code:: python
|
||||||
|
|
||||||
@ -130,6 +133,7 @@ Feedback
|
|||||||
|
|
||||||
Means for getting in touch:
|
Means for getting in touch:
|
||||||
|
|
||||||
|
- `Community`_
|
||||||
- `Telegram`_
|
- `Telegram`_
|
||||||
- `GitHub`_
|
- `GitHub`_
|
||||||
- `Email`_
|
- `Email`_
|
||||||
@ -156,12 +160,16 @@ License
|
|||||||
|
|
||||||
.. _`Telegram`: https://t.me/haskell
|
.. _`Telegram`: https://t.me/haskell
|
||||||
|
|
||||||
|
.. _`Community`: https://t.me/PyrogramChat
|
||||||
|
|
||||||
.. _`bot-like`: https://core.telegram.org/bots/api#available-methods
|
.. _`bot-like`: https://core.telegram.org/bots/api#available-methods
|
||||||
|
|
||||||
.. _`GitHub`: https://github.com/pyrogram/pyrogram/issues
|
.. _`GitHub`: https://github.com/pyrogram/pyrogram/issues
|
||||||
|
|
||||||
.. _`Email`: admin@pyrogram.ml
|
.. _`Email`: admin@pyrogram.ml
|
||||||
|
|
||||||
|
.. _TgCrypto: https://docs.pyrogram.ml/resources/TgCrypto
|
||||||
|
|
||||||
.. _`GNU Lesser General Public License v3 or later (LGPLv3+)`: COPYING.lesser
|
.. _`GNU Lesser General Public License v3 or later (LGPLv3+)`: COPYING.lesser
|
||||||
|
|
||||||
.. |header| raw:: html
|
.. |header| raw:: html
|
||||||
@ -177,7 +185,7 @@ License
|
|||||||
<b>Telegram MTProto API Client Library for Python</b>
|
<b>Telegram MTProto API Client Library for Python</b>
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
<a href="https://pypi.python.org/pypi/Pyrogram">
|
<a href="https://github.com/pyrogram/pyrogram/releases/latest">
|
||||||
Download
|
Download
|
||||||
</a>
|
</a>
|
||||||
•
|
•
|
||||||
@ -193,9 +201,9 @@ License
|
|||||||
<img src="https://www.pyrogram.ml/images/scheme.svg"
|
<img src="https://www.pyrogram.ml/images/scheme.svg"
|
||||||
alt="Scheme Layer 75">
|
alt="Scheme Layer 75">
|
||||||
</a>
|
</a>
|
||||||
<a href="https://core.telegram.org/mtproto">
|
<a href="https://github.com/pyrogram/tgcrypto">
|
||||||
<img src="https://www.pyrogram.ml/images/mtproto.svg"
|
<img src="https://www.pyrogram.ml/images/tgcrypto.svg"
|
||||||
alt="MTProto v2.0">
|
alt="TgCrypto">
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@ -209,6 +217,6 @@ License
|
|||||||
:target: compiler/api/source/main_api.tl
|
:target: compiler/api/source/main_api.tl
|
||||||
:alt: Scheme Layer 75
|
:alt: Scheme Layer 75
|
||||||
|
|
||||||
.. |mtproto| image:: https://www.pyrogram.ml/images/mtproto.svg
|
.. |tgcrypto| image:: https://www.pyrogram.ml/images/tgcrypto.svg
|
||||||
:target: https://core.telegram.org/mtproto
|
:target: https://github.com/pyrogram/tgcrypto
|
||||||
:alt: MTProto v2.0
|
:alt: TgCrypto
|
||||||
|
Loading…
Reference in New Issue
Block a user