Skip to content

Commit fee5e46

Browse files
committed
Merge branch 'master' of https://github.com/pyrogram/pyrogram
2 parents 9fce809 + 2be431c commit fee5e46

1 file changed

Lines changed: 34 additions & 13 deletions

File tree

README.rst

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,6 @@ for Python application developers. It offers simple and complete access to the
4545
Requirements
4646
============
4747

48-
- Operating systems:
49-
50-
- Linux
51-
52-
- macOS
53-
54-
- Windows
55-
5648
- Python 3.3 or higher.
5749

5850
- A Telegram API key.
@@ -61,19 +53,41 @@ Requirements
6153
Installation
6254
============
6355

64-
You can install and upgrade the library using standard Python tools:
56+
You can easily install and upgrade the library using standard Python tools:
6557

6658
.. code:: shell
6759
6860
$ pip install --upgrade pyrogram
69-
61+
7062
7163
Getting Started
7264
===============
7365

74-
The `Wiki`_ contains all the information needed to get you started with Pyrogram:
66+
- Create a new ``config.ini`` file at the root of your working directory, copy-paste
67+
the following and replace the **api_id** and **api_hash** values with `your own`_:
7568

76-
- `Getting Started`_
69+
.. code:: ini
70+
71+
[pyrogram]
72+
api_id = 12345
73+
api_hash = 0123456789abcdef0123456789abcdef
74+
75+
- Then you can start with this:
76+
77+
.. code:: python
78+
79+
from pyrogram import Client
80+
81+
client = Client(session_name="example")
82+
client.start()
83+
84+
# Get information about yourself
85+
print(client.get_me())
86+
87+
That's all you need for getting started with Pyrogram. For more detailed information,
88+
please refer to the `Wiki`_:
89+
90+
- `Introduction`_
7791

7892

7993
Development
@@ -145,7 +159,9 @@ License
145159

146160
.. _`Wiki`: https://github.com/pyrogram/pyrogram/wiki
147161

148-
.. _`Getting Started`: https://github.com/pyrogram/pyrogram/wiki/Getting-Started
162+
.. _`your own`: https://github.com/pyrogram/pyrogram/wiki/Getting-Started#api-keys
163+
164+
.. _`Introduction`: https://github.com/pyrogram/pyrogram/wiki/Getting-Started
149165

150166
.. _`Telegram`: https://t.me/joinchat/AWDQ8lK2HgBN7ka4OyWVTw
151167

@@ -167,7 +183,12 @@ License
167183

168184
<p align="center">
169185
<b>Telegram MTProto API Client Library for Python</b>
186+
170187
<br>
188+
<a href="https://pypi.python.org/pypi/Pyrogram">
189+
Download
190+
</a>
191+
171192
<a href="https://github.com/pyrogram/pyrogram/wiki">
172193
Wiki
173194
</a>

0 commit comments

Comments
 (0)