From b87e280e93fcc12fa1fdac6b6f265f0058af328a Mon Sep 17 00:00:00 2001
From: Berk Polat <berkpolat125@gmail.com>
Date: Mon, 26 Jan 2026 17:32:02 +0300
Subject: [PATCH] added: readme for nuget

---
 FlowMediator/FlowMediator.csproj | 32 ++++++++++++-----
 README.NUGET.md                  | 62 ++++++++++++++++++++++++++++++++
 2 files changed, 85 insertions(+), 9 deletions(-)
 create mode 100644 README.NUGET.md

diff --git a/FlowMediator/FlowMediator.csproj b/FlowMediator/FlowMediator.csproj
index 2d1333c..6104dfc 100644
--- a/FlowMediator/FlowMediator.csproj
+++ b/FlowMediator/FlowMediator.csproj
@@ -3,21 +3,35 @@
   <PropertyGroup>
     <TargetFrameworks>net9.0;net8.0</TargetFrameworks>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <Version>1.2.0</Version>
+    <Version>2.0.0</Version>
     <PackageId>FlowMediator</PackageId>
     <Authors>berk2k</Authors>
     <Description>
-      FlowMediator is a lightweight mediator library with pipeline behaviors and domain events for .NET 8/9. 
-      Ideal for hobby projects, or learning CQRS patterns without the complexity of bigger frameworks. 
-      Provides request/response messaging, pipeline behaviors (logging, validation), and EF Core domain event support.
+      FlowMediator is an opinionated mediator library for explicit application flow in .NET 8 and .NET 9.
+
+      It provides clear separation between request-based application flow (SendAsync)
+      and event-based side effects (PublishAsync), with pipeline support for CQRS-style
+      applications and explicit event handling.
+
     </Description>
-    <PackageTags>mediator cqrs pipeline domain-events .net lightweight hobby</PackageTags>
+
+    <PackageTags>
+      mediator cqrs application-flow events ddd
+    </PackageTags>
+
     <RepositoryUrl>https://github.com/berk2k/FlowMediator</RepositoryUrl>
     <PackageProjectUrl>https://github.com/berk2k/FlowMediator</PackageProjectUrl>
     <PackageReleaseNotes>
-      v1.2.0 - Added Domain Event support with EF Core integration. Improved README and documentation.
-    </PackageReleaseNotes>
-    <PackageReadmeFile>README.md</PackageReadmeFile>
+      v2.0.0
+      - Explicit separation between Send (application flow) and Publish (events)
+      - Events are no longer treated as requests
+      - Multiple event handlers supported
+      - Pipeline applies only to SendAsync
+      - Event handlers are executed sequentially and synchronously
+      - Breaking change: migration from v1.x is required
+</PackageReleaseNotes>
+
+    <PackageReadmeFile>README.NUGET.md</PackageReadmeFile>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
@@ -25,7 +39,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.8" />
-    <None Include="..\README.md" Pack="true" PackagePath="\" />
+    <None Include="..\README.NUGET.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
 </Project>
diff --git a/README.NUGET.md b/README.NUGET.md
new file mode 100644
index 0000000..2ba6521
--- /dev/null
+++ b/README.NUGET.md
@@ -0,0 +1,62 @@
+FlowMediator is a lightweight, opinionated mediator library for .NET 8 and .NET 9.
+
+It simplifies **CQRS-style application flow** by explicitly separating
+request-based operations (commands and queries)
+from event-driven side effects.
+
+FlowMediator provides request/response messaging and pipeline behaviors
+with a predictable and transparent execution model.
+
+---
+
+Use FlowMediator when you want:
+
+- Clear separation between application flow and events
+- Simple request/response messaging without boilerplate
+- Predictable mediator behavior
+- A lightweight alternative to generic mediator frameworks
+
+
+## Installation
+
+```bash
+dotnet add package FlowMediator
+```
+
+## Core Usage
+### Command / Query (SendAsync)
+
+``` csharp
+var user = await mediator.SendAsync(new GetUserByIdQuery(1));
+```
+- Single handler
+- Pipeline-enabled (logging, validation, etc.)
+
+### Events (PublishAsync)
+``` csharp
+await mediator.PublishAsync(new UserCreatedEvent());
+```
+
+- Multiple handlers supported
+- No response
+- Side-effect oriented
+
+Event handlers are executed sequentially and synchronously by default.
+
+## Key Concepts
+- SendAsync -> application flow (commands / queries)
+- PublishAsync -> event notifications
+- Events are not treated as requests
+- Pipelines apply only to SendAsync
+
+## Documentation
+Full documentation, migration guide, and roadmap are available on GitHub:
+👉 https://github.com/berk2k/FlowMediator
+
+License: MIT
+
+
+
+
+
+