Change readme and index page.

This commit is contained in:
Alex Root Junior 2017-07-29 05:37:13 +03:00
parent e90ca7cfae
commit add7c7f864
3 changed files with 43 additions and 11 deletions

View file

@ -1,6 +1,17 @@
# AIOGramBot
# AIOGram
[![Documentation Status](https://readthedocs.org/projects/aiogram/badge/?version=latest)](http://aiogram.readthedocs.io/en/latest/?badge=latest)
Asynchonyously Python framework for [Telegram Bot API](https://core.telegram.org/bots/api)
**aiogram** is are pretty simple and fully asynchronously library for [Telegram Bot API](https://core.telegram.org/bots/api) written in Python 3.6 with [asyncio](https://docs.python.org/3/library/asyncio.html) and [aiohttp](https://github.com/aio-libs/aiohttp). It helps to make your bots more faster and simpler.
You can [read the docs here](http://aiogram.readthedocs.io/en/latest/).
You can [read the docs here](http://aiogram.readthedocs.io/en/latest/).
## Official aiogram resources:
- News: [@aiogram_live](https://t.me/aiogram_live)
- Community: [@aiogram](https://t.me/aiogram)
- Russian community: [@aiogram_ru](https://t.me/aiogram_ru)
- Pip: [aiogram](https://pypi.python.org/pypi/aiogram)
- Docs: [ReadTheDocs](http://aiogram.readthedocs.io)
- Source: [Bitbucket repo](https://bitbucket.org/illemius/aiogram)
- Issues/Bug tracker: [Bitbucket issues tracker](https://bitbucket.org/illemius/aiogram/issues)
- Test bot: [@aiogram_bot](https://t.me/aiogram_bot)

View file

@ -26,6 +26,18 @@ AIOGramBot
:alt: MIT License
Asynchonyously Python framework for `Telegram Bot API <https://core.telegram.org/bots/api>`_
**aiogram** is are pretty simple and fully asynchronously library for `Telegram Bot API <https://core.telegram.org/bots/api>`_ written in Python 3.6 with `asyncio <https://docs.python.org/3/library/asyncio.html>`_ and `aiohttp <https://github.com/aio-libs/aiohttp>`_. It helps to make your bots more faster and simpler.
You can `read the docs here <http://aiogram.readthedocs.io/en/latest/>`_.
You can `read the docs here <http://aiogram.readthedocs.io/en/latest/>`_.
Official aiogram resources
--------------------------
- News: `@aiogram_live <https://t.me/aiogram_live>`_
- Community: `@aiogram <https://t.me/aiogram>`_
- Russian community: `@aiogram_ru <https://t.me/aiogram_ru>`_
- Pip: `aiogram <https://pypi.python.org/pypi/aiogram>`_
- Docs: `ReadTheDocs <http://aiogram.readthedocs.io>`_
- Source: `Bitbucket repo <https://bitbucket.org/illemius/aiogram>`_
- Issues/Bug tracker: `Bitbucket issues tracker <https://bitbucket.org/illemius/aiogram/issues>`_
- Test bot: `@aiogram_bot <https://t.me/aiogram_bot>`_

View file

@ -1,11 +1,5 @@
.. aiogram documentation master file, created by
sphinx-quickstart on Sat Jun 3 11:22:58 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to aiogram's documentation!
===================================
Asynchonyously Python framework for `Telegram Bot API <https://core.telegram.org/bots/api>`_
.. image:: https://img.shields.io/pypi/v/aiogram.svg
@ -33,12 +27,27 @@ Welcome to aiogram's documentation!
:alt: MIT License
**aiogram** is are pretty simple and fully asynchronously library for `Telegram Bot API <https://core.telegram.org/bots/api>`_ written in Python 3.6 with `asyncio <https://docs.python.org/3/library/asyncio.html>`_ and `aiohttp <https://github.com/aio-libs/aiohttp>`_. It helps to make your bots more faster and simpler.
Official aiogram resources
--------------------------
- News: `@aiogram_live <https://t.me/aiogram_live>`_
- Community: `@aiogram <https://t.me/aiogram>`_
- Russian community: `@aiogram_ru <https://t.me/aiogram_ru>`_
- Pip: `aiogram <https://pypi.python.org/pypi/aiogram>`_
- Docs: `ReadTheDocs <http://aiogram.readthedocs.io>`_
- Source: `Bitbucket repo <https://bitbucket.org/illemius/aiogram>`_
- Issues/Bug tracker: `Bitbucket issues tracker <https://bitbucket.org/illemius/aiogram/issues>`_
- Test bot: `@aiogram_bot <https://t.me/aiogram_bot>`_
Features
--------
- Asynchronous
- Be awesome
- Make things faster
- Have `FSM <https://en.wikipedia.org/wiki/Finite-state_machine>`_
Contribute
----------