upd readme
This commit is contained in:
16
README.md
16
README.md
@@ -1,11 +1,11 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://qbot.botforge.biz"><img src="https://qbot.botforge.biz/img/qbot.svg" alt="QBot"></a>
|
<a href="https://quickbot.botforge.biz"><img src="https://quickbot.botforge.biz/img/qbot.svg" alt="QuickBot"></a>
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<em>Telegram Bots Rapid Application Development (RAD) Framework.</em>
|
<em>Telegram Bots Rapid Application Development (RAD) Framework.</em>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
**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
|
## Key Features
|
||||||
|
|
||||||
@@ -16,13 +16,13 @@
|
|||||||
- **Context Preservation** – Store navigation stacks and user interaction states in the database.
|
- **Context Preservation** – Store navigation stacks and user interaction states in the database.
|
||||||
- **Internationalization Support** – Localizable UI and string fields for multilingual bots.
|
- **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
|
## Benefits
|
||||||
|
|
||||||
- **Faster Development** – Automate repetitive tasks and build bots in record time.
|
- **Faster Development** – Automate repetitive tasks and build bots in record time.
|
||||||
- **Highly Modular** – Easily extend and customize functionality.
|
- **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.
|
- **Enterprise-Grade Structure** – Scalable, maintainable, and optimized for real-world usage.
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
@@ -38,12 +38,12 @@ class AppEntity(BotEntity):
|
|||||||
)
|
)
|
||||||
|
|
||||||
name: str # entity field with default sqlmodel's FieldInfo descriptor
|
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
|
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",
|
caption = "Age",
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ async def menu(context: CommandCallbackContext):
|
|||||||
```
|
```
|
||||||
## Result
|
## Result
|
||||||
|
|
||||||
<iframe width="100%" height="691" src="https://www.youtube.com/embed/ptTnoppkYfM" title="QBot Framework – The Open-Source RAD Tool for Telegram Bots" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
|
<iframe width="100%" height="691" src="https://www.youtube.com/embed/ptTnoppkYfM" title="QuickBot Framework – The Open-Source RAD Tool for Telegram Bots" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
|
||||||
|
|
||||||
Here you can see the result - [YouTube Video with Bot](https://www.youtube.com/shorts/ptTnoppkYfM)
|
Here you can see the result - [YouTube Video with Bot](https://www.youtube.com/shorts/ptTnoppkYfM)
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
site_name: QBot Framework
|
site_name: QuickBot Framework
|
||||||
site_url: https://qbot.botforge.biz
|
site_url: https://quickbot.botforge.biz
|
||||||
theme:
|
theme:
|
||||||
name: material
|
name: material
|
||||||
palette:
|
palette:
|
||||||
@@ -10,5 +10,5 @@ theme:
|
|||||||
code: 'Roboto Mono'
|
code: 'Roboto Mono'
|
||||||
logo: 'img/qbot_1_1.svg'
|
logo: 'img/qbot_1_1.svg'
|
||||||
favicon: 'img/qbot_1_1.svg'
|
favicon: 'img/qbot_1_1.svg'
|
||||||
repo_name: botforge/qbot
|
repo_name: botforge/quickbot
|
||||||
repo_url: https://git.botforge.biz/botforge/qbot
|
repo_url: https://git.botforge.biz/botforge/quickbot
|
||||||
|
|||||||
Reference in New Issue
Block a user