Add a new super simple README.rst

This commit is contained in:
Lonami Exo 2017-08-24 19:08:21 +02:00
parent b05b43153c
commit 633bf4684a

59
README.rst Executable file
View File

@ -0,0 +1,59 @@
Telethon
========
.. epigraph::
⭐️ Thanks **everyone** who has starred the project, it means a lot!
**Telethon** is Telegram client implementation in **Python 3** which uses
the latest available API of Telegram. Remember to use **pip3** to install!
Installing
----------
.. code:: sh
pip install telethon
Creating a client
-----------------
.. code:: python
from telethon import TelegramClient
# These example values won't work. You must get your own api_id and
# api_hash from https://my.telegram.org, under API Development.
api_id = 12345
api_hash = '0123456789abcdef0123456789abcdef'
phone = '+34600000000'
client = TelegramClient('session_name', api_id, api_hash)
client.connect()
# If you already have a previous 'session_name.session' file, skip this.
client.send_code_request(phone)
me = client.sign_in(phone, 77777) # Put whatever code you received here.
Doing stuff
-----------
.. code:: python
print(me.stringify())
client.send_message('username', 'Hello! Talking to you from Telethon')
client.send_file('username', '/home/myself/Pictures/holidays.jpg')
client.download_profile_photo(me)
total, messages, senders = client.get_message_history('username')
client.download_media(messages[0])
Next steps
----------
Once you've decided that you like the way Telethon looks and feel comfortable
with this code, go ahead and read the full
`README <https://github.com/LonamiWebs/Telethon/blob/HEAD/README-long.rst>`_ :)