TeamPGM/tgcrypto
2
0
Fork 0
mirror of https://github.com/TeamPGM/tgcrypto.git synced 2024-11-22 07:27:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.rst

Browse Source
This commit is contained in:
Dan 2018-02-19 15:37:57 +01:00
parent 4774a63e40
commit be8f6e278e
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
View File

@ -20,9 +20,9 @@ Table of Contents
About About
===== =====
**TgCrypto** is a high-performance, easy-to-install Telegram Crypto Library specifically written in C for Pyrogram [#f1]_ as a **TgCrypto** is a high-performance, easy-to-install Telegram Crypto Library written in C as a Python extension.
Python extension. TgCrypto is a replacement for the much slower PyAES and implements the crypto algorithms Telegram requires, TgCrypto is intended for Pyrogram [#f1]_ and implements the crypto algorithms Telegram requires, namely
namely **AES-IGE 256 bit** (used in MTProto v2.0) and **AES-CTR 256 bit** (used for CDN encrypted files). **AES-IGE 256 bit** (used in MTProto v2.0) and **AES-CTR 256 bit** (used for CDN encrypted files).
Installation Installation
============ ============
@ -31,8 +31,9 @@ Installation
$ pip install --upgrade tgcrypto $ pip install --upgrade tgcrypto
**Note:** Being a C extension for Python, TgCrypto is an optional but *highly recommended* dependency; when TgCrypto **Note:** Being a C extension for Python, TgCrypto is an optional but *highly recommended* Pyrogram_ dependency;
is not detected in your system, Pyrogram will automatically fall back to PyAES and will show you a warning. 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 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 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 .. [#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 .. _`Community`: https://t.me/PyrogramChat
@ -135,7 +136,7 @@ License
</h1> </h1>
<p align="center"> <p align="center">
<b>Telegram Crypto Library for <a href="https://github.com/pyrogram/pyrogram">Pyrogram</a></b> <b>Fast Telegram Crypto Library for Python</b>
<br> <br>
<a href="https://pypi.python.org/pypi/TgCrypto"> <a href="https://pypi.python.org/pypi/TgCrypto">
@ -149,10 +150,15 @@ License
<a href="https://t.me/PyrogramChat"> <a href="https://t.me/PyrogramChat">
Community Community
</a> </a>
<br><br>
<a href="https://github.com/pyrogram/tgcrypto">
<img src="https://www.pyrogram.ml/images/tgcrypto_version.svg"
alt="TgCrypto">
</a>
</p> </p>
.. |logo| image:: https://pyrogram.ml/images/tgcrypto_logo.png .. |logo| image:: https://pyrogram.ml/images/tgcrypto_logo.png
:target: https://github.com/pyrogram/tgcrypto :target: https://github.com/pyrogram/tgcrypto
:alt: TgCrypto :alt: TgCrypto
.. |description| replace:: **Telegram Crypto Library for Pyrogram** .. |description| replace:: **Fast Telegram Crypto Library for Python**