Updated Home (markdown)

Jannes Höke 2016-05-31 15:06:22 +02:00
parent 1c1d114669
commit 3064993f07

11
Home.md

@ -1 +1,10 @@
Welcome to the python-telegram-bot wiki! ![Logo](https://github.com/python-telegram-bot/logos/raw/master/logo-text/png/ptb-logo-text_768.png)
### About this Wiki
For a long time, our documentation consisted of our [API documentation](http://pythonhosted.org/python-telegram-bot/) and README. As a result, the README became simply too big to be useful. In an effort to change that, we moved large parts of our README into different Wiki articles. In the process, we improved the texts with additional information, clearer wording and some cross-references.
### How to read this Wiki
Ideally, this Wiki should read a bit like a [Choose Your Own Adventure](https://en.wikipedia.org/wiki/Choose_Your_Own_Adventure) book - You start with [page one](https://github.com/python-telegram-bot/python-telegram-bot/wiki/Introduction-to-the-API) and choose you way through the docs, depending on your preferences. At the end of most articles, you will find a section called **What to read next?**, where related articles are linked.
### Outlook
Over the next weeks and months, I (Jannes) will invest some time writing new articles, extending or improving existing ones and organizing them. Among other things, I'm planning an _Under the Hood_ series, where I go into the implementation details of (mostly) the `telegram.ext` submodule, to give you a better understanding on how they work and how you can get the best out of them.