mirror of
https://github.com/TeamPGM/pyrogram.git
synced 2024-11-16 12:51:18 +00:00
Update README.rst
This commit is contained in:
parent
ec1d3094c2
commit
f558439600
51
README.rst
51
README.rst
@ -23,6 +23,10 @@ Table of Contents
|
|||||||
|
|
||||||
- `Using Raw Functions`_
|
- `Using Raw Functions`_
|
||||||
|
|
||||||
|
- `Development`_
|
||||||
|
|
||||||
|
- `Documentation`_
|
||||||
|
|
||||||
- `Contribution`_
|
- `Contribution`_
|
||||||
|
|
||||||
- `Feedback`_
|
- `Feedback`_
|
||||||
@ -94,7 +98,8 @@ Getting Started
|
|||||||
===============
|
===============
|
||||||
|
|
||||||
This section provides all the information you need to start using Pyrogram.
|
This section provides all the information you need to start using Pyrogram.
|
||||||
There are a couple of steps you have to follow before you can use the library:
|
There are a couple of steps you have to follow before you can use the library
|
||||||
|
to make API calls.
|
||||||
|
|
||||||
Setup
|
Setup
|
||||||
-----
|
-----
|
||||||
@ -166,9 +171,6 @@ The result is a much cleaner interface that allows you to:
|
|||||||
|
|
||||||
client.send_message(chat_id="me", text="Hi there! I'm using Pyrogram")
|
client.send_message(chat_id="me", text="Hi there! I'm using Pyrogram")
|
||||||
|
|
||||||
**Note:** Currently, only a limited number of such high-level methods are
|
|
||||||
available.
|
|
||||||
|
|
||||||
Using Raw Functions
|
Using Raw Functions
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
@ -203,18 +205,53 @@ Client class:
|
|||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
Development
|
||||||
|
===========
|
||||||
|
|
||||||
|
The library is still in its early stages, thus lots of functionalities aiming to
|
||||||
|
make working with Telegram's API easy are yet to be added.
|
||||||
|
|
||||||
|
However, being the core functionalities already implemented, every Telegram API
|
||||||
|
method listed in the API scheme can be used right away; the goal is therefore to
|
||||||
|
build a powerful, simple to use, `bot-like`_ interface on top of those low-level
|
||||||
|
functions.
|
||||||
|
|
||||||
|
|
||||||
|
Documentation
|
||||||
|
=============
|
||||||
|
|
||||||
|
Soon. For now, have a look at the ``pyrogram.Client`` code to get some insights.
|
||||||
|
|
||||||
|
Currently you are able to easily:
|
||||||
|
|
||||||
|
- ``send_message``
|
||||||
|
|
||||||
|
- ``forward_messages``
|
||||||
|
|
||||||
|
- ``edit_message_text``
|
||||||
|
|
||||||
|
- ``delete_messages``
|
||||||
|
|
||||||
|
- ``send_chat_action``
|
||||||
|
|
||||||
|
- Some more...
|
||||||
|
|
||||||
|
as well as listening for updates and catching API errors.
|
||||||
|
|
||||||
|
|
||||||
Contribution
|
Contribution
|
||||||
============
|
============
|
||||||
|
|
||||||
You are welcome to contribute by either submitting pull requests or reporting
|
**You are very welcome to contribute** by either submitting pull requests or
|
||||||
issues/bugs as well as suggesting features and best practices.
|
reporting issues/bugs as well as suggesting best practices, ideas, enhancements
|
||||||
Any help is appreciated.
|
on both code and documentation. Any help is appreciated!
|
||||||
|
|
||||||
|
|
||||||
Feedback
|
Feedback
|
||||||
========
|
========
|
||||||
|
|
||||||
|
Means for getting in touch:
|
||||||
|
|
||||||
- `Telegram`_
|
- `Telegram`_
|
||||||
- `Github`_
|
- `Github`_
|
||||||
- `Email`_
|
- `Email`_
|
||||||
|
Loading…
Reference in New Issue
Block a user