mirror of
https://github.com/TeamPGM/pyrogram.git
synced 2024-11-23 23:34:28 +00:00
Add description on docs' welcome page
This commit is contained in:
parent
675c69a617
commit
f3dbfd1f4e
@ -1,6 +1,3 @@
|
||||
Welcome to Pyrogram
|
||||
===================
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div align="center">
|
||||
@ -11,8 +8,47 @@ Welcome to Pyrogram
|
||||
|
||||
<p align="center">
|
||||
<b>Telegram MTProto API Client Library for Python</b>
|
||||
<br><br>
|
||||
<a href="compiler/api/source/main_api.tl">
|
||||
<img src="https://www.pyrogram.ml/images/scheme.svg"
|
||||
alt="Scheme Layer 74">
|
||||
</a>
|
||||
<a href="https://core.telegram.org/mtproto">
|
||||
<img src="https://www.pyrogram.ml/images/mtproto.svg"
|
||||
alt="MTProto v2.0">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
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 developers
|
||||
keen on building custom Telegram applications.
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
- **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.
|
||||
|
||||
- **Updated**: Pyrogram makes use of the latest Telegram API version, currently **Layer 74**.
|
||||
|
||||
- **Documented**: Pyrogram API public methods are documented and resemble the well
|
||||
established Telegram Bot API, thus offering a familiar look to Bot developers.
|
||||
|
||||
- **Full API support**: Beside the simple, bot-like methods offered by the Pyrogram API,
|
||||
the library also provides a complete, low-level access to every single Telegram API method.
|
||||
|
||||
Preview
|
||||
-------
|
||||
|
||||
@ -28,12 +64,6 @@ Preview
|
||||
|
||||
client.stop()
|
||||
|
||||
About
|
||||
-----
|
||||
|
||||
Welcome to the Pyrogram's documentation! Here you can find resources for learning how to use the library.
|
||||
Contents are organized by topic and are accessible from the sidebar.
|
||||
|
||||
To get started, press Next.
|
||||
|
||||
.. toctree::
|
||||
|
Loading…
Reference in New Issue
Block a user