From be8f6e278e15dcc49f0f62fa7492b0dd08a1a2e6 Mon Sep 17 00:00:00 2001 From: Dan <14043624+delivrance@users.noreply.github.com> Date: Mon, 19 Feb 2018 15:37:57 +0100 Subject: [PATCH] Update README.rst --- README.rst | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index dec58ce..0a6b2d5 100644 --- a/README.rst +++ b/README.rst @@ -20,9 +20,9 @@ Table of Contents About ===== -**TgCrypto** is a high-performance, easy-to-install Telegram Crypto Library specifically written in C for Pyrogram [#f1]_ as a -Python extension. TgCrypto is a replacement for the much slower PyAES and implements the crypto algorithms Telegram requires, -namely **AES-IGE 256 bit** (used in MTProto v2.0) and **AES-CTR 256 bit** (used for CDN encrypted files). +**TgCrypto** is a high-performance, easy-to-install Telegram Crypto Library written in C as a Python extension. +TgCrypto is intended for Pyrogram [#f1]_ and implements the crypto algorithms Telegram requires, namely +**AES-IGE 256 bit** (used in MTProto v2.0) and **AES-CTR 256 bit** (used for CDN encrypted files). Installation ============ @@ -31,8 +31,9 @@ Installation $ pip install --upgrade tgcrypto -**Note:** Being a C extension for Python, TgCrypto is an optional but *highly recommended* dependency; when TgCrypto -is not detected in your system, Pyrogram will automatically fall back to PyAES and will show you a warning. +**Note:** Being a C extension for Python, TgCrypto is an optional but *highly recommended* Pyrogram_ dependency; +if TgCrypto is not detected in your system, Pyrogram will automatically fall back to the much slower PyAES and will +show you a warning. The reason about being an optional package is that TgCrypto requires some extra system tools in order to be compiled. The errors you receive when trying to install TgCrypto are system dependent, but also descriptive enough to understand @@ -111,7 +112,7 @@ License ----- .. [#f1] Although TgCrypto is intended for `Pyrogram`_, it is shipped as a standalone package and can thus be used for - other Python projects too. + any other Python project too. .. _`Community`: https://t.me/PyrogramChat @@ -135,7 +136,7 @@ License

- Telegram Crypto Library for Pyrogram + Fast Telegram Crypto Library for Python
@@ -149,10 +150,15 @@ License Community +

+ + TgCrypto +

.. |logo| image:: https://pyrogram.ml/images/tgcrypto_logo.png :target: https://github.com/pyrogram/tgcrypto :alt: TgCrypto -.. |description| replace:: **Telegram Crypto Library for Pyrogram** \ No newline at end of file +.. |description| replace:: **Fast Telegram Crypto Library for Python** \ No newline at end of file