add custom README for NuGet package which only uses Markdown as HTML is not supported by the NuGet gallary

Author: henningtandberg

Mando/Mando/Mando.csproj

@@ -6,11 +6,11 @@
         <Nullable>enable</Nullable>
         <RootNamespace>Mando</RootNamespace>
         <PackageIcon>mando.png</PackageIcon>
-        <PackageReadmeFile>README.md</PackageReadmeFile>
+        <PackageReadmeFile>README.NuGet.md</PackageReadmeFile>
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="../../README.md" Pack="true" PackagePath="\" />
+        <None Include="../../README.NuGet.md" Pack="true" PackagePath="\" />
         <None Include="../../mando.png" Pack="true" PackagePath="\" />
     </ItemGroup>
 

README.NuGet.md

@@ -0,0 +1,99 @@
+# Mando
+A super lightweight and free alternative to libraries that provide
+decoupled, in-process communication.
+
+![Mando Logo](mando.png)
+
+[![Build and Test](https://github.com/henningtandberg/Mando/actions/workflows/build-test.yml/badge.svg)](https://github.com/henningtandberg/Mando/actions/workflows/build-test.yml)
+![GitHub License](https://img.shields.io/github/license/henningtandberg/Mando)
+![GitHub Release](https://img.shields.io/github/v/release/henningtandberg/Mando)
+![NuGet Version](https://img.shields.io/nuget/v/Mando)
+![NuGet Downloads](https://img.shields.io/nuget/dt/Mando)
+
+---
+
+## Usage
+You can use the package directly or fork this repo and create your own,
+custom implementation.
+
+## Installation
+The easiest way to add Mando to your project via [NuGet](https://www.nuget.org/packages/Mando).
+
+## Features
+The features of this library are limited by design, so that the library will
+be easier to extend if you decide to fork the repo and create a more custom
+implementation. The core features are, and will always be:
+
+### Single command, single handler.
+```csharp
+internal sealed MyCustomCommand : ICommand;
+
+internal sealed MyCustomCommandHandler : ICommandHandler<MyCustomCommand>
+{
+    public Task Execute(MyCustomCommand command)
+    {
+        // Your magic here!
+    }
+}
+```
+
+### Single command, multiple handlers.
+```csharp
+internal sealed MyCustomCommand : ICommand;
+
+internal sealed MyCustomCommandHandlerOne : ICommandHandler<MyCustomCommand>
+{
+    public Task Execute(MyCustomCommand command)
+    {
+        // Your magic here!
+    }
+}
+
+internal sealed MyCustomCommandHandlerTwo : ICommandHandler<MyCustomCommand>
+{
+    public Task Execute(MyCustomCommand command)
+    {
+        // And some other magic here!
+    }
+}
+```
+
+### Multiple commands, single handler
+
+```csharp
+internal sealed MyCustomCommandOne : ICommand;
+internal sealed MyCustomCommandTwo : ICommand;
+
+internal sealed MyCustomCommandHandler :
+    ICommandHandler<MyCustomCommandOne>, ICommandHandler<MyCustomCommandTwo>
+{
+    public Task Execute(MyCustomCommandOne command)
+    {
+        // Your magic here!
+    }
+    
+    public Task Execute(MyCustomCommandTwo command)
+    {
+        // Even more magic here!
+    }
+}
+```
+
+### Dependency Injection
+```csharp
+services.AddMando(Assembly.GetExecutingAssembly()))
+```
+
+This registers
+- `ICommandHandler<TCommand>` : All implementations are registered as Scoped
+- `IDispatcher` as Scoped
+
+### Usage
+```csharp
+internal sealed class Application(IDispatcher dispatcher) : IApplication
+{
+    public Task RunAsync() => dispatcher.Dispatch(new DoSomethingCommand());
+}
+```
+
+Checkout [Mando.Example](https://github.com/henningtandberg/Mando/tree/main/Mando/Mando.Example) for a working example.