From ab2f684565292ac1f4b81a596650849bd5633cfb Mon Sep 17 00:00:00 2001 From: Dan <14043624+delivrance@users.noreply.github.com> Date: Sat, 17 Feb 2018 15:35:49 +0100 Subject: [PATCH] Update README.rst --- README.rst | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 6475b81d..e14ec7cc 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ Table of Contents ================= -- `Overview`_ +- `About`_ - `Features`_ @@ -26,8 +26,8 @@ Table of Contents - `License`_ -Overview -======== +About +===== **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 @@ -37,20 +37,23 @@ developers keen on building custom Telegram applications. 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 of code to get started with. - **Easy to use**: Pyrogram provides idiomatic, developer-friendly, clean and readable Python code (either generated or hand-written) making the Telegram API simple to use. - + - **High level**: Pyrogram automatically handles all the low-level details of communication with the Telegram servers by implementing the `MTProto Mobile Protocol v2.0`_ and the mechanisms needed for establishing 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`_. - + - **Documented**: Pyrogram API public methods are documented and resemble the well established Telegram Bot API, thus offering a familiar look to Bot developers. @@ -93,7 +96,7 @@ Configuration Usage ----- -- And here's how Pyrogram looks: +- And here's how Pyrogram looks like: .. code:: python @@ -130,6 +133,7 @@ Feedback Means for getting in touch: +- `Community`_ - `Telegram`_ - `GitHub`_ - `Email`_ @@ -156,12 +160,16 @@ License .. _`Telegram`: https://t.me/haskell +.. _`Community`: https://t.me/PyrogramChat + .. _`bot-like`: https://core.telegram.org/bots/api#available-methods .. _`GitHub`: https://github.com/pyrogram/pyrogram/issues .. _`Email`: admin@pyrogram.ml +.. _TgCrypto: https://docs.pyrogram.ml/resources/TgCrypto + .. _`GNU Lesser General Public License v3 or later (LGPLv3+)`: COPYING.lesser .. |header| raw:: html @@ -177,7 +185,7 @@ License Telegram MTProto API Client Library for Python
- + Download • @@ -193,9 +201,9 @@ License Scheme Layer 75 - - MTProto v2.0 + + TgCrypto

@@ -209,6 +217,6 @@ License :target: compiler/api/source/main_api.tl :alt: Scheme Layer 75 -.. |mtproto| image:: https://www.pyrogram.ml/images/mtproto.svg - :target: https://core.telegram.org/mtproto - :alt: MTProto v2.0 +.. |tgcrypto| image:: https://www.pyrogram.ml/images/tgcrypto.svg + :target: https://github.com/pyrogram/tgcrypto + :alt: TgCrypto