-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature/nuget package documentation and icon updated (#1)
* icon updated * Nuget package documentation updated * Nuget package documentation updated * Nuget package documentation and icon updated * icon updated * icon updated * Documentation updated --------- Co-authored-by: Denis Peshkov <[email protected]>
- Loading branch information
1 parent
52fdf67
commit 8df365d
Showing
5 changed files
with
70 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,58 @@ | ||
# Cross.CQRS | ||
[![Nuget](https://img.shields.io/nuget/v/Cross.CQRS.svg)](https://nuget.org/packages/Cross.CQRS/) | ||
|
||
# Cross.CQRS | ||
|
||
Simple .NET MediatR base Query, Command, Event and Validation. | ||
|
||
Event Queue and Validation behaviors written on C#. | ||
|
||
Main Features: | ||
* **Queries, and QueryHandlers**. | ||
|
||
Implemented base patterns to work with Queries. The Queries used just to get any data. | ||
|
||
* **Commands and CommandHandlers**. | ||
|
||
Implemented base patterns to work with Commands. The Commands used to modify entities. | ||
|
||
* **Events, EventHandlers, EventWriter and EventReader**. | ||
|
||
Implemented base patterns to crate Events, approach how to write a new Events from the Commands, consuming patterns and behavior to handle it. | ||
The main idea is to do some actions after the Commands have to be finished, to avoid cases when one Command call another one. | ||
|
||
* **Validation**. | ||
|
||
Here included validation behavior based on FluentValidation, that allow to validate Queries and Command before their execution. | ||
|
||
* **.NET Standard 2.1 and Source Linking**. | ||
|
||
From version 1.0 repository contains .NET Standard 2.0, .NET 6 and .NET 7 projects. | ||
Source linking enabled and symbol package is published to nuget symbols server, making debugging easier. | ||
|
||
## Install with nuget.org: | ||
|
||
https://www.nuget.org/packages/Cross.CQRS | ||
|
||
## Installation | ||
|
||
Clone repository or Install Nuget Package | ||
``` | ||
Install-Package Cross.CQRS | ||
``` | ||
|
||
## Issues and Pull Request | ||
|
||
Contribution is welcomed. If you would like to provide a PR please add some testing. | ||
|
||
## How To's | ||
|
||
Please use [Wiki](https://github.com/denis-peshkov/Cross.CQRS/wiki) for documentation and usage examples. | ||
|
||
### Complete usage examples can be found in the test project ### | ||
Note - test project is not a part of nuget package. You have to clone repository. | ||
|
||
## Roadmap: | ||
- ~~Queries implementation~~ | ||
- ~~Commands Implementation~~ | ||
- ~~Validation behavior~~ (based on FluentValidation) | ||
- ~~Events~~ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
dotnet build --configuration release ..\Cross.CQRS.sln | ||
dotnet build --configuration release ..\Cross.CQRS.sln | ||
nuget.exe pack config.nuspec -Symbols -SymbolPackageFormat snupkg |