Skip to content

Commit

Permalink
Feature/nuget package documentation and icon updated (#1)
Browse files Browse the repository at this point in the history
* 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
denis-peshkov and denis-peshkov committed Nov 13, 2023
1 parent 52fdf67 commit 8df365d
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 9 deletions.
59 changes: 58 additions & 1 deletion README.md
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~~
5 changes: 5 additions & 0 deletions ReleaseNotes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,8 @@ Added Net 6.0 targeted libraries.
Added Net 7.0 targeted libraries.

1.0.0 - 31 Oct 2023
Release.

1.0.1 - 13 Nov 2023
Readme updated.
Icon updated.
13 changes: 6 additions & 7 deletions _nuget/config.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,20 @@
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata>
<id>Cross.CQRS</id>
<version>1.0.0</version>
<version>1.0.1</version>
<authors>denis-peshkov</authors>
<owners>denis-peshkov</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<license type="expression">MIT</license>
<readme>docs\README.md</readme>
<projectUrl>https://github.com/denis-peshkov/Cross.CQRS</projectUrl>
<!-- <iconUrl>http://github.com/contoso/UsefulStuff/nuget_icon.png</iconUrl> -->
<icon>icon.png</icon>
<releaseNotes>
Initial version.
Added Sourcelink.
Package updates.
Only netstandard2.1, net6.0, net7.0 is now supported.
Documentation updated.
Icon updated.
</releaseNotes>
<description>Simple .NET MediatR base Query, Command, Event. Event Queue and Validation behaviors. Written on C#.</description>
<tags>.NET Mediatr Query Command Event EventQueueBehavior Validation ValidationBehavior SyntaxNotes NetCore</tags>
<tags>.NET Mediatr Query QueryHandler Command CommandHandler Event EventHandler EventQueueBehavior Validation ValidationBehavior SyntaxNotes NetCore</tags>
<repository type="git" url="https://github.com/denis-peshkov/Cross.CQRS" />
<dependencies>
<dependency id="FluentValidation" version="11.8.0" />
Expand All @@ -34,5 +32,6 @@
<file src="..\Cross.CQRS\bin\Release\net6.0\Cross.CQRS*.* " target="lib\net6.0" />
<file src="..\Cross.CQRS\bin\Release\net7.0\Cross.CQRS*.* " target="lib\net7.0" />
<file src="..\README.md" target="docs\" />
<file src="..\icon.png" target="" />
</files>
</package>
2 changes: 1 addition & 1 deletion _nuget/pkg.bat
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
Binary file added icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8df365d

Please sign in to comment.