Update examples README.md

This commit is contained in:
Dan 2018-05-06 13:20:29 +02:00 committed by GitHub
parent 735dfb6a0c
commit b0eee21730
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,19 +1,19 @@
# Examples
This folder contains example scripts to show you how **Pyrogram** looks like.
You can start with [hello_world.py](https://github.com/pyrogram/pyrogram/blob/master/examples/hello_world.py)
and continue with the more advanced examples.
Every script is working right away (provided you correctly set up your credentials), meaning
you can simply copy-paste and run, the only things you have to change are your session names and the target chats.
you can simply copy-paste and run. The only things you have to change are session names and target chats.
- [**hello_world.py**](hello_world.py)
- [**echo_bot.py**](echo_bot.py)
- [**welcome_bot.py**](welcome_bot.py)
- [**get_history.py**](get_history.py)
- [**get_participants.py**](get_participants.py)
- [**get_participants2.py**](get_participants2.py)
- [**query_inline_bots.py**](query_inline_bots.py)
- [**send_bot_keyboards.py**](send_bot_keyboards.py)
- [**callback_query_handler.py**](callback_query_handler.py)
- [**raw_update_handler.py**](raw_update_handler.py)
Example | Description
---: | :---
[**hello_world**](hello_world.py) | Demonstration of basic API usages
[**echo_bot**](echo_bot.py) | Echo bot that replies to every private text message
[**welcome_bot**](welcome_bot.py) | The Welcome Bot source code in [@PyrogramChat](https://t.me/pyrogramchat)
[**get_history**](get_history.py) | How to retrieve the full message history of a chat
[**get_participants**](get_participants.py) | How to get the first 10.000 members of a supergroup/channel
[**get_participants2**](get_participants2.py) | Improved version to get more than 10.000 users
[**query_inline_bots**](query_inline_bots.py) | How to query an inline bot and send a result to a chat
[**send_bot_keyboards**](send_bot_keyboards.py) | How to send normal and inline keyboards using regular bots
[**callback_query_handler**](callback_query_handler.py) | How to handle queries coming from inline button presses
[**raw_update_handler**](raw_update_handler.py) | How to handle raw updates (old, should be avoided)