Add welcome text and why use this library

Lonami 2017-09-10 16:00:05 +02:00
parent 914c091b7e
commit 8e0d018054

16
Home.md

@ -1,4 +1,18 @@
This wiki page is meant to be a place where everyone can find and contribute examples on how to use Telethon.
Welcome to the wiki! This place hosts all the information you need in order to work with this library. **Telethon** is a Telegram client implementation in **Python** which uses the latest available API of Telegram. Check the links on the sidebar for more!
Before opening an issue about how to use the library, **please** make sure you've investigated and read the wiki enough! Issues lacking of any sense at all end on the [Wall of Shame](https://github.com/LonamiWebs/Telethon/wiki/Wall-of-Shame).
## Why Telethon?
> Why should I bother with Telethon? There are more mature projects already, such as [`telegram-cli`](https://github.com/vysheng/tg) with even (limited) Python support. And we have the [official](https://github.com/telegramdesktop/tdesktop>) [clients](https://github.com/DrKLO/Telegram>)!
With Telethon you don't really need to know anything before using it. Create a client with your settings.
Connect. You're ready to go.
Being written **entirely** on Python, Telethon can run as a script under any environment you wish, (yes,
[Android too](https://f-droid.org/repository/browse/?fdfilter=termux&fdid=com.termux>)). You can schedule it,
or use it in any other script you have. Want to send a message to someone when you're available? Write a script.
Do you want check for new messages at a given time and find relevant ones? Write a script.
**It is very important** that your system time is [on sync](https://time.is/)! Telegram won't send a reply back *at all* if your system time is too ahead of the current time, or too behind. This will most likely be the cause for the following errors:
```