From d3cec77e78b123db0e5fec9018cc644c907dd174 Mon Sep 17 00:00:00 2001 From: Rahiel Kasim Date: Sun, 24 Apr 2016 18:27:24 +0200 Subject: [PATCH] README: make smaller, fix links, add "Getting help" section --- README.rst | 55 +++++++++++++++++++----------------------------------- 1 file changed, 19 insertions(+), 36 deletions(-) diff --git a/README.rst b/README.rst index 9fd2a261a..fb6286d18 100644 --- a/README.rst +++ b/README.rst @@ -11,6 +11,10 @@ Not **just** a Python wrapper around the Telegram Bot API :target: https://pypi.python.org/pypi/python-telegram-bot :alt: PyPi Package Version +.. image:: https://img.shields.io/pypi/pyversions/python-telegram-bot.svg + :target: https://pypi.python.org/pypi/python-telegram-bot + :alt: Supported python versions + .. image:: https://img.shields.io/pypi/dm/python-telegram-bot.svg :target: https://pypi.python.org/pypi/python-telegram-bot :alt: PyPi Package Monthly Download @@ -45,11 +49,7 @@ Table of contents - `Introduction`_ -- `Status`_ - - #. `Telegram API support`_ - - #. `Python Version support`_ +- `Telegram API support`_ - `Installing`_ @@ -71,7 +71,7 @@ Table of contents - `License`_ -- `Contact`_ +- `Getting help`_ - `Contributing`_ @@ -81,13 +81,9 @@ _`Introduction` This library provides a pure Python interface for the `Telegram Bot API `_. It works with Python versions from 2.6+. It also works with `Google App Engine `_. -========= -_`Status` -========= - ------------------------ +======================= _`Telegram API support` ------------------------ +======================= ========================= ============ Telegram Bot API Method *Supported?* @@ -117,31 +113,11 @@ editMessageReplyMarkup Yes answerCallbackQuery Yes ========================= ============ -------------------------- -_`Python Version support` -------------------------- - -============== ============ -Python Version *Supported?* -============== ============ -2.6 Yes -2.7 Yes -3.3 Yes -3.4 Yes -3.5 Yes -PyPy Yes -PyPy3 Yes -============== ============ - ============= _`Installing` ============= -You can install python-telegram-bot using:: - - $ pip install python-telegram-bot==4.0rc1 - -Or upgrade to the latest version:: +You can install or upgrade python-telegram-bot with:: $ pip install python-telegram-bot==4.0rc1 --upgrade @@ -216,7 +192,7 @@ Note: Using the ``Bot`` class directly is the 'old' method, we have an easier wa The API is exposed via the ``telegram.Bot`` class. -To generate an Access Token you have to talk to `BotFather `_ and follow a few simple steps (described `here `_). +To generate an Access Token you have to talk to `BotFather `_ and follow a few simple steps (described `here `_). For full details see the `Bots: An introduction for developers `_. @@ -439,10 +415,17 @@ _`License` You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under `LGPL-3 `_, but applications that use the library don't have to be. ========== -_`Contact` +_`Getting help` ========== -Feel free to join to our `Telegram group `_. +You can get help in several ways: + +1. We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! + +2. You can ask for help on Stack Overflow using the `python-telegram-bot tag `_. + +3. As last resort, the developers are ready to help you with `serious issues `_. + =============== _`Contributing`