Skip to content

Commit d943471

Browse files
committed
README.md
1 parent d98696b commit d943471

1 file changed

Lines changed: 15 additions & 13 deletions

File tree

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ This separation improves clarity, testability, and scalability.
4040

4141
A command represents an intention to change state. It is handled by a single handler and returns a result.
4242

43-
📖 Read more → command.md
43+
📖 Read more → [command.md](https://github.com/bordunosp/bus/blob/master/doc/command.md)
4444

4545
---
4646

4747
## 🔍 Query
4848
A query retrieves data without modifying state. It is also handled by a single handler.
4949

50-
📖 Read more → query.md
50+
📖 Read more → [query.md](https://github.com/bordunosp/bus/blob/master/doc/query.md)
5151

5252
---
5353

@@ -58,8 +58,8 @@ In-memory — handled immediately during bus::publish(...)
5858

5959
Database-backed — persisted and processed asynchronously by background workers
6060

61-
* 📖 Read more → event.md
62-
* 📖 Database-backed events → event_database_sea_orm.md
61+
* 📖 Read more → [event.md](https://github.com/bordunosp/bus/blob/master/doc/event.md)
62+
* 📖 Database-backed events → [event_database_sea_orm.md](https://github.com/bordunosp/bus/blob/master/doc/event_database_sea_orm.md)
6363

6464
---
6565

@@ -87,7 +87,7 @@ Add `bus` to your `Cargo.toml`:
8787

8888
```toml
8989
[dependencies]
90-
bus = { git = "https://github.com/your-org/bus" }
90+
bus = { git = "https://github.com/bordunosp/bus" }
9191
ctor = "0.2" # Required for automatic handler & pipeline registration
9292
```
9393

@@ -110,6 +110,8 @@ All required migrations are located in the root of the repository under the migr
110110
└── ...
111111
```
112112

113+
[migration](https://github.com/bordunosp/bus/blob/master/migration)
114+
113115
You can apply them using your preferred migration tool (e.g. SeaORM CLI, refinery, sqlx-cli, or manually via psql/MySQL client).
114116

115117
---
@@ -141,14 +143,14 @@ You can apply them using your preferred migration tool (e.g. SeaORM CLI, refiner
141143
| Topic | File |
142144
|:-------|:---------------------------|
143145
| 🧭 CQRS Overview | this file |
144-
| 🔨 Commands | command.md |
145-
| 🔍 Queries | query.md |
146-
| 📣 Events (in-memory) | event.md |
147-
| 🗃️ Events (database-backed) | event_database_sea_orm.md |
148-
| 🧩 Event Pipelines (in-memory) | event_pipeline.md |
149-
| 🧩 Event Pipelines (database) | event_database_pipeline.md |
150-
| 🧩 Request Pipelines | request_pipeline.md |
151-
| 🛠 Migrations | bus app folder migration |
146+
| 🔨 Commands | [command.md](https://github.com/bordunosp/bus/blob/master/doc/command.md) |
147+
| 🔍 Queries | [query.md](https://github.com/bordunosp/bus/blob/master/doc/query.md) |
148+
| 📣 Events (in-memory) | [event.md](https://github.com/bordunosp/bus/blob/master/doc/event.md) |
149+
| 🗃️ Events (database-backed) | [event_database_sea_orm.md](https://github.com/bordunosp/bus/blob/master/doc/event_database_sea_orm.md) |
150+
| 🧩 Event Pipelines (in-memory) | [event_pipeline.md](https://github.com/bordunosp/bus/blob/master/doc/event_pipeline.md) |
151+
| 🧩 Event Pipelines (database) | [event_database_pipeline.md](https://github.com/bordunosp/bus/blob/master/doc/event_database_pipeline.md) |
152+
| 🧩 Request Pipelines | [request_pipeline.md](https://github.com/bordunosp/bus/blob/master/doc/request_pipeline.md) |
153+
| 🛠 Migrations | bus app folder [migration](https://github.com/bordunosp/bus/blob/master/migration) |
152154

153155

154156
---

0 commit comments

Comments
 (0)