Skip to content

Commit 14ce62f

Browse files
author
Вадим Козыревский
committed
Update documentation
1 parent 5c487e0 commit 14ce62f

2 files changed

Lines changed: 38 additions & 8 deletions

File tree

docs/index.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,6 @@
2525

2626
</div>
2727

28-
!!! warning "Breaking Changes in v5.0.0"
29-
Starting with version 5.0.0, **Pydantic support will become optional**. The default implementations of `Request`, `Response`, `DomainEvent`, and `NotificationEvent` will be migrated to dataclasses-based implementations.
30-
3128
---
3229

3330
## Core Features
@@ -78,7 +75,7 @@
7875

7976
- :material-puzzle: **Integrations**
8077

81-
FastAPI, FastStream, Kafka, and Protobuf integrations out of the box.
78+
FastAPI and FastStream integrations out of the box.
8279

8380
[:octicons-arrow-right-24: Read More](fastapi.md)
8481

@@ -99,10 +96,22 @@
9996
**Key Highlights:**
10097

10198
- :material-rocket-launch: **Performance** — Separation of commands and queries, parallel event processing
102-
- :material-shield-check: **Reliability** — Transaction Outbox for guaranteed event delivery
103-
- :material-check-circle: **Type Safety**Full Pydantic v2 support with runtime validation
104-
- :material-puzzle: **Ready Integrations** — FastAPI, FastStream, Kafka out of the box
99+
- :material-shield-check: **Reliability** — Transaction Outbox for guaranteed event delivery, Saga with compensation support and eventual consistency
100+
- :material-check-circle: **Flexible Types**Easy integration with any type: [Pydantic, dataclasses, msgspec, attrs, TypedDict and more](request_response_types/index.md)
101+
- :material-puzzle: **Ready Integrations** — FastAPI and FastStream out of the box
105102
- :material-lightning-bolt: **Simple Setup** — Bootstrap for quick configuration
103+
- :material-application-braces: **Proven Patterns** — CQRS, Saga, Outbox and more to keep services decoupled and maintainable
104+
105+
---
106+
107+
## Project status
108+
109+
| Group | Badges |
110+
|-------|--------|
111+
| Python version & PyPI | [![Python Versions](https://img.shields.io/pypi/pyversions/python-cqrs?logo=python&logoColor=white)](https://pypi.org/project/python-cqrs/) [![PyPI](https://img.shields.io/pypi/v/python-cqrs?label=pypi&logo=pypi)](https://pypi.org/project/python-cqrs/) |
112+
| Downloads | [![Total downloads](https://pepy.tech/badge/python-cqrs)](https://pepy.tech/projects/python-cqrs) [![Downloads per month](https://pepy.tech/badge/python-cqrs/month)](https://pepy.tech/projects/python-cqrs) |
113+
| Quality & CI | [![Coverage](https://img.shields.io/codecov/c/github/vadikko2/python-cqrs?logo=codecov&logoColor=white)](https://codecov.io/gh/vadikko2/python-cqrs) [![CodSpeed](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/vadikko2/python-cqrs?utm_source=badge) |
114+
| Documentation & community | [![Documentation](https://img.shields.io/badge/docs-mkdocs-blue?logo=readthedocs)](https://mkdocs.python-cqrs.dev/) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/vadikko2/python-cqrs) |
106115

107116
---
108117

@@ -123,7 +132,7 @@ uv pip install python-cqrs
123132
```
124133

125134
!!! info "Requirements"
126-
Python 3.8+ • Pydantic v2
135+
Python 3.10+
127136

128137
---
129138

docs/stylesheets/extra.css

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,27 @@
1212
--timeweb-border: rgba(0, 102, 204, 0.15);
1313
--timeweb-border-dark: rgba(0, 102, 204, 0.2);
1414
--timeweb-shadow: rgba(0, 102, 204, 0.2);
15+
/* Тёмно-синяя шапка */
16+
--header-bg: #0d47a1;
17+
}
18+
19+
/* Шапка сайта — тёмно-синий */
20+
.md-header,
21+
.md-tabs {
22+
background-color: var(--header-bg) !important;
23+
}
24+
25+
.md-header .md-header__title,
26+
.md-header .md-header__button,
27+
.md-header a,
28+
.md-tabs .md-tabs__link {
29+
color: rgba(255, 255, 255, 0.9) !important;
30+
}
31+
32+
.md-header .md-header__button:hover,
33+
.md-header a:hover,
34+
.md-tabs .md-tabs__link:hover {
35+
color: #fff !important;
1536
}
1637

1738
/* Импорт шрифтов IBM Plex из Google Fonts */

0 commit comments

Comments
 (0)