Add package readme

CHG-MERIDIAN · Oct 6, 2023 · 81ae387 · 81ae387
1 parent bb58bc0
commit 81ae387
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/src/NServiceBus.Persistence.Sqlite/NServiceBus.Persistence.Sqlite.csproj b/src/NServiceBus.Persistence.Sqlite/NServiceBus.Persistence.Sqlite.csproj
@@ -21,6 +21,7 @@
 		<ProjectGuid>{05F93302-01C5-4482-B049-7EED9968A54A}</ProjectGuid>
 		<IncludeSymbols>true</IncludeSymbols>
 		<SymbolPackageFormat>snupkg</SymbolPackageFormat>
+		<PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
 	<ItemGroup>
@@ -38,6 +39,7 @@
   </ItemGroup>
 
 	<ItemGroup>
-		<None Include="icon.png" Pack="true" Visible="false" PackagePath="." />
+		<None Include="icon.png" Pack="true" Visible="false" PackagePath="\" />
+		<None Include="README.md" Pack="true" PackagePath="\"/>
 	</ItemGroup>
 </Project>
diff --git a/src/NServiceBus.Persistence.Sqlite/README.md b/src/NServiceBus.Persistence.Sqlite/README.md
@@ -0,0 +1,12 @@
+# NServiceBus.Persistence.Sqlite
+
+NServiceBus persistence implementation for Sqlite
+
+## Usage
+
+Install the NuGet package `CHG.NServiceBus.Persistence.Sqlite`.
+
+```CSharp
+var persistence = endpointConfiguration.UsePersistence<SqlitePersistence>();
+persistence.UseConnectionString("Data Source=file:SagaStore.db");
+```