From 60fe0931a72b4b02588d5d153d1903a05be81496 Mon Sep 17 00:00:00 2001 From: Martin Winks <50446230+uwinx@users.noreply.github.com> Date: Sun, 13 Sep 2020 23:11:27 +0400 Subject: [PATCH] docs(readme): prettify readme, update downloads stats badge (#406) * docs(readme): prettify readme, update downloads stats badge * chore(readme): describe steps for minimal code * chore(rme): remove comma etc Co-authored-by: evgfilim1 * chore(rme): add heading for details/summary blocks * Update README.md Co-authored-by: evgfilim1 Co-authored-by: Alex Root Junior --- README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 60 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dfef918f..5cc22e92 100644 --- a/README.md +++ b/README.md @@ -13,15 +13,72 @@ **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. -You can [read the docs here](http://docs.aiogram.dev/en/latest/). + +## Examples +
+ 📚 Click to see some basic examples + + +**Few steps before getting started...** +- First, you should obtain token for your bot from [BotFather](https://t.me/BotFather). +- Install latest stable version of aiogram, simply running `pip install aiogram` + +### 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)