From 682ee41bc669f0fae95c3de7960a572fdfe6b34f Mon Sep 17 00:00:00 2001 From: Jimmy Bogard Date: Thu, 6 Jan 2022 08:51:14 -0600 Subject: [PATCH] Updating readme to include contracts package --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 15b05f12..4f6e1f42 100644 --- a/README.md +++ b/README.md @@ -25,3 +25,18 @@ Or via the .NET Core command line interface: dotnet add package MediatR Either commands, from Package Manager Console or .NET Core CLI, will download and install MediatR and all required dependencies. + +### Using Contracts-Only Package + +To reference only the contracts for MediatR, which includes: + +- `IRequest` (including generic variants and `Unit`) +- `INotification` +- `IStreamRequest` + +Add a package reference to [MediatR.Contracts](https://www.nuget.org/packages/MediatR.Contracts) + +This package is useful in scenarios where your MediatR contracts are in a separate assembly/project from handlers. Example scenarios include: +- API contracts +- GRPC contracts +- Blazor \ No newline at end of file