switch to readthedocs

Jannes Höke 2016-10-19 18:08:41 +02:00
parent a38f263a02
commit 02fc969277

@ -1,7 +1,7 @@
[![Logo](https://github.com/python-telegram-bot/logos/raw/master/logo-text/png/ptb-logo-text_768.png)](https://python-telegram-bot.org/)
### 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.
For a long time, our documentation consisted of our [API documentation](http://python-telegram-bot.readthedocs.io/) 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.