diff --git a/README.md b/README.md index dfef918f..3f45d0d3 100644 --- a/README.md +++ b/README.md @@ -4,24 +4,78 @@ [![\[Telegram\] aiogram live](https://img.shields.io/badge/telegram-aiogram-blue.svg?style=flat-square)](https://t.me/aiogram_live) [![PyPi Package Version](https://img.shields.io/pypi/v/aiogram.svg?style=flat-square)](https://pypi.python.org/pypi/aiogram) [![PyPi status](https://img.shields.io/pypi/status/aiogram.svg?style=flat-square)](https://pypi.python.org/pypi/aiogram) -[![Downloads](https://img.shields.io/pypi/dm/aiogram.svg?style=flat-square)](https://pypi.python.org/pypi/aiogram) +[![Downloads](https://pepy.tech/badge/aiogram)](https://pepy.tech/project/aiogram) [![Supported python versions](https://img.shields.io/pypi/pyversions/aiogram.svg?style=flat-square)](https://pypi.python.org/pypi/aiogram) [![Telegram Bot API](https://img.shields.io/badge/Telegram%20Bot%20API-4.9-blue.svg?style=flat-square&logo=telegram)](https://core.telegram.org/bots/api) [![Documentation Status](https://img.shields.io/readthedocs/aiogram?style=flat-square)](http://docs.aiogram.dev/en/latest/?badge=latest) [![Github issues](https://img.shields.io/github/issues/aiogram/aiogram.svg?style=flat-square)](https://github.com/aiogram/aiogram/issues) [![MIT License](https://img.shields.io/pypi/l/aiogram.svg?style=flat-square)](https://opensource.org/licenses/MIT) -**aiogram** is a pretty simple and fully asynchronous framework for [Telegram Bot API](https://core.telegram.org/bots/api) written in Python 3.7 with [asyncio](https://docs.python.org/3/library/asyncio.html) and [aiohttp](https://github.com/aio-libs/aiohttp). It helps you to make your bots faster and simpler. +**aiogram** is a pretty simple and fully asynchronous framework for [Telegram Bot API](https://core.telegram.org/bots/api) written in Python 3.7 with [asyncio](https://docs.python.org/3/library/asyncio.html) and [aiohttp](https://github.com/aio-libs/aiohttp). It helps you to make your bots faster and as simple as. -You can [read the docs here](http://docs.aiogram.dev/en/latest/). + +
+ 📚 Some simple code examples + + +First, you should obtain token for your bot from [BotFather](https://t.me/BotFather). + +### Simple [`getMe`](https://core.telegram.org/bots/api#getme) request + +```python +import asyncio +from aiogram import Bot + + +async def main(): + bot = Bot(token=BOT-TOKEN) + + try: + me = await bot.get_me() + print(f"🤖 Hello, I'm {me.first_name}.\nHave a nice Day!") + finally: + await bot.close() + +asyncio.run(main()) +``` + +### Poll BotAPI for updates and process updates + +```python +import asyncio +from aiogram import Bot, Dispatcher, types + +async def start_handler(event: types.Message): + await event.answer( + f"Hello, {event.from_user.get_mention(as_html=True)} 👋!", + parse_mode=types.ParseMode.HTML, + ) + +async def main(): + bot = Bot(token=BOT-TOKEN) + try: + disp = Dispatcher(bot=bot) + disp.register_message_handler(start_handler, commands={"start", "restart"}) + await disp.start_polling() + finally: + await bot.close() + +asyncio.run(main()) +``` + +### Moar! + +You can find more examples in [`examples/`](https://github.com/aiogram/aiogram/tree/dev-2.x/examples) directory + +
## 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: [aiogram site](https://docs.aiogram.dev/) + - PyPI: [aiogram](https://pypi.python.org/pypi/aiogram) + - Documentation: [aiogram site](https://docs.aiogram.dev/en/latest/) - Source: [Github repo](https://github.com/aiogram/aiogram) - Issues/Bug tracker: [Github issues tracker](https://github.com/aiogram/aiogram/issues) - Test bot: [@aiogram_bot](https://t.me/aiogram_bot)