python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2026-04-08 16:37:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

docs(readme): prettify readme, update downloads stats badge (#406)

Browse source 
* docs(readme): prettify readme, update downloads stats badge

* chore(readme): describe steps for minimal code

* chore(rme): remove comma etc

Co-authored-by: evgfilim1 <evgfilim1@yandex.ru>

* chore(rme): add heading for details/summary blocks

* Update README.md

Co-authored-by: evgfilim1 <evgfilim1@yandex.ru>
Co-authored-by: Alex Root Junior <jroot.junior@gmail.com>
This commit is contained in:
Martin Winks 2020-09-13 23:11:27 +04:00 • committed by GitHub
parent 00202565e4
commit 60fe0931a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 60 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -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
<details>
<summary>📚 Click to see some basic examples</summary>
**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
</details>
## 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)