Updating README

This commit is contained in:
Leandro Toledo 2015-07-10 22:21:52 -03:00
parent 8ab910bd62
commit a11bbba099
2 changed files with 25 additions and 23 deletions

View file

@ -1,20 +1,8 @@
help:
@echo " env create a development environment using virtualenv"
@echo " deps install dependencies"
@echo " clean remove unwanted stuff"
@echo " lint check style with flake8"
@echo " test run tests"
env:
sudo easy_install pip && \
pip install virtualenv && \
virtualenv env && \
. env/bin/activate && \
make deps
deps:
pip install -r requirements.txt
clean:
rm -fr build
rm -fr dist

View file

@ -12,7 +12,29 @@ By `Leandro Toledo <leandrotoledodesouza@gmail.com>`_
Introduction
============
This library provides a pure Python interface for the `Telegram Bot API <https://core.telegram.org/bots/api>`_. It works with Python versions from 2.6+. Python 3 support is under development.
This library provides a pure Python interface for the `Telegram Bot API <https://core.telegram.org/bots/api>`_. It works with Python versions from 2.6+. Python 3 support is under development. It also works with `Google App Engine <https://cloud.google.com/appengine>`_.
==========
Status
==========
+-------+-------------------+--------------+
| Telegram Bot API Method | *Supported?* |
+=======+===================+==============+
| getMe | Yes |
| sendMessage | Yes |
| forwardMessage | Yes |
| sendPhoto | Yes |
| sendAudio | Yes |
| sendDocument | Yes |
| sendSticker | Yes |
| sendVideo | Yes |
| sendLocation | Yes |
| sendChatAction | Yes |
| getUpdates | Yes |
| getUserProfilePhotos | Yes |
| setWebhook | Yes |
+-------+-------------------+--------------+
==========
Installing
@ -33,21 +55,13 @@ Check out the latest development version anonymously with::
$ git clone https://github.com/leandrotoledo/python-telegram-bot
$ cd python-telegram-bot
Setup a virtual environment and install dependencies:
$ make env
Activate the virtual environment created:
$ source env/bin/activate
Run tests:
$ make test
$ make test
To see other options available, run:
$ make help
$ make help
=============
Documentation