Add a NuGet readme file for the next version

Abc-Arbitrage · Sep 28, 2023 · ebe134c · ebe134c
1 parent 56dddc1
commit ebe134c
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/src/Abc.Zebus.sln b/src/Abc.Zebus.sln
@@ -21,6 +21,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "@ Solution Items", "@ Solut
 		nuget.config = nuget.config
 		..\.github\workflows\build.yml = ..\.github\workflows\build.yml
 		Abc.Zebus.Tests.proj = Abc.Zebus.Tests.proj
+		NuGetReadme.md = NuGetReadme.md
+		..\README.md = ..\README.md
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Abc.Zebus.Contracts", "Abc.Zebus.Contracts\Abc.Zebus.Contracts.csproj", "{507A4411-DB8A-4663-A491-CCA29854B890}"

diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -31,8 +31,13 @@
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <Copyright>Copyright © ABC arbitrage $([System.DateTime]::Now.ToString('yyyy'))</Copyright>
     <PackageOutputPath>$(MSBuildThisFileDirectory)..\output</PackageOutputPath>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="$(MSBuildThisFileDirectory)NuGetReadme.md" Pack="true" PackagePath="/README.md" Visible="false" />
+  </ItemGroup>
+
   <PropertyGroup Condition="'$(NCrunch)' == '1'">
     <EnableSourceLink>false</EnableSourceLink>
     <EnableSourceControlManagerQueries>false</EnableSourceControlManagerQueries>

diff --git a/src/NuGetReadme.md b/src/NuGetReadme.md
@@ -0,0 +1,5 @@
+# Zebus
+
+Zebus is a lightweight peer to peer service bus, built with CQRS principles in mind. It allows applications to communicate with each other in a fast and easy manner. Most of the complexity is hidden in the library and you can focus on writing code that matters to you, not debugging messaging code.
+
+See the [GitHub repository](https://github.com/Abc-Arbitrage/Zebus) for more information.