Revise OpenCQRS description in README

[lucabriguglia]

Update description for OpenCQRS

Summary by CodeRabbit

• Documentation
  • Updated README to present OpenCQRS as a .NET framework for DDD, CQRS, and Event Sourcing.
  • Clarified flexible usage from a simple mediator to a full event-sourcing solution.
  • Refreshed supported storage options (Cosmos DB, Entity Framework Core).
  • Expanded listed integrations (Service Bus, RabbitMQ, Redis Cache, Memory Cache, FluentValidation).
  • Removed Azure Service Bus‑specific wording and improved overall clarity and scope.

[coderabbitai]

Walkthrough

Rewrites README.md to broaden OpenCQRS description: from a .NET Core library with Azure Service Bus and specific databases to a .NET framework for DDD, CQRS, and Event Sourcing, noting mediator or full event-sourcing modes, Cosmos DB or EF Core storage, and built-in integrations (Service Bus, RabbitMQ, Redis Cache, Memory Cache, FluentValidation).

Changes

Cohort / File(s)	Summary
Documentation README.md	Revised product description to generalize scope (framework vs. library), describe operational modes (mediator or full event sourcing), update storage options (Cosmos DB, EF Core), and list built-in integrations (Service Bus, RabbitMQ, Redis Cache, Memory Cache, FluentValidation), removing Azure-Service-Bus-only emphasis.

Sequence Diagram(s)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I twitch my nose at README’s cheer,
New lines hop in — the path is clear.
From queues to caches, features play,
A framework hops along its way.
I munch a carrot — changelog near. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "Revise OpenCQRS description in README" succinctly and accurately describes the primary change in this pull request: updating the README entry for OpenCQRS. It is concise, references the affected component (OpenCQRS README) and avoids noisy or vague language. A reviewer scanning PR history will understand the main intent without needing further detail.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fd3682b and e84e5bd.

📒 Files selected for processing (1)

• README.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

README.md (2)

654-654: Tighten the copy and align with list style; avoid marketing phrasing.

Single sentence; no “among other features”; consistent commas; use concise separators.

-* [OpenCQRS](https://github.com/OpenCQRS/OpenCQRS) - OpenCQRS is a .NET framework for DDD, CQRS, and Event Sourcing. It can be used as a simple mediator or as a full Event Sourcing solution with Cosmos DB or Entity Framework Core as storage. It has built-in support for Service Bus, RabbitMQ, Redis Cache, Memory Cache, and FluentValidation among other features.
+* [OpenCQRS](https://github.com/OpenCQRS/OpenCQRS) - .NET framework for DDD, CQRS, and Event Sourcing; usable as a mediator or a full event-sourcing solution with Cosmos DB or Entity Framework Core storage; built-in support for Service Bus, RabbitMQ, Redis Cache, MemoryCache, and FluentValidation.

---

654-654: Clarify provider names in README.md (line 654).

OpenCQRS documents built-in providers for Azure Service Bus, RabbitMQ, FluentValidation, and both in‑memory and Redis caching — update wording for clarity and .NET naming consistency:

• "Service Bus" → "Azure Service Bus"
• "Rabbit MQ" → "RabbitMQ"
• "Fluent Validation" → "FluentValidation"
• "Redis Cache" → "Redis (Redis Cache provider)"
• "Memory Cache" → "MemoryCache (in‑memory)"

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d25db57 and fd3682b.

📒 Files selected for processing (1)

• README.md (1 hunks)