From f417c7741c872d6e6ff6b1081d5b0ecf046a7f5e Mon Sep 17 00:00:00 2001 From: Alexander Kalinovsky Date: Thu, 27 Mar 2025 16:26:43 +0700 Subject: [PATCH] upd readme --- README.md | 16 ++++++++-------- mkdocs.yml | 8 ++++---- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 22a6df2..aad27d1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@

- QBot + QuickBot

Telegram Bots Rapid Application Development (RAD) Framework.

-**QBot** is a library for fast development of Telegram bots and mini-apps following the **RAD (Rapid Application Development)** principle in a **declarative style**. +**QuickBot** is a library for fast development of Telegram bots and mini-apps following the **RAD (Rapid Application Development)** principle in a **declarative style**. ## Key Features @@ -16,13 +16,13 @@ - **Context Preservation** – Store navigation stacks and user interaction states in the database. - **Internationalization Support** – Localizable UI and string fields for multilingual bots. -**QBot** powered by **[FastAPI](https://fastapi.tiangolo.com)**, **[SQLModel](https://sqlmodel.tiangolo.com)** & **[aiogram](https://aiogram.dev)** – Leverage the full capabilities of these frameworks for high performance and flexibility. +**QuickBot** powered by **[FastAPI](https://fastapi.tiangolo.com)**, **[SQLModel](https://sqlmodel.tiangolo.com)** & **[aiogram](https://aiogram.dev)** – Leverage the full capabilities of these frameworks for high performance and flexibility. ## Benefits - **Faster Development** – Automate repetitive tasks and build bots in record time. - **Highly Modular** – Easily extend and customize functionality. -- **Less Code Duplication** – Focus on core features while QBot handles the rest. +- **Less Code Duplication** – Focus on core features while QuickBot handles the rest. - **Enterprise-Grade Structure** – Scalable, maintainable, and optimized for real-world usage. ## Example @@ -38,12 +38,12 @@ class AppEntity(BotEntity): ) name: str # entity field with default sqlmodel's FieldInfo descriptor - # and default qbot's field descriptor + # and default quickbot's field descriptor description: str | None = Field( # field with sqlmodel's descriptor - sa_type = String, index = True) # and default qbot's descriptor + sa_type = String, index = True) # and default quickbot's descriptor - age: int = EntityField( # field with qbot's descriptor + age: int = EntityField( # field with quickbot's descriptor caption = "Age", ) @@ -92,7 +92,7 @@ async def menu(context: CommandCallbackContext): ``` ## Result - + Here you can see the result - [YouTube Video with Bot](https://www.youtube.com/shorts/ptTnoppkYfM) diff --git a/mkdocs.yml b/mkdocs.yml index 50385a5..74e8994 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ -site_name: QBot Framework -site_url: https://qbot.botforge.biz +site_name: QuickBot Framework +site_url: https://quickbot.botforge.biz theme: name: material palette: @@ -10,5 +10,5 @@ theme: code: 'Roboto Mono' logo: 'img/qbot_1_1.svg' favicon: 'img/qbot_1_1.svg' -repo_name: botforge/qbot -repo_url: https://git.botforge.biz/botforge/qbot +repo_name: botforge/quickbot +repo_url: https://git.botforge.biz/botforge/quickbot