reqnroll · 304NotModified · Aug 16, 2025 · Aug 16, 2025 · Aug 16, 2025 · Aug 16, 2025
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,10 +3,11 @@
 ## Improvements:
 
 * Add xUnit 3 support (#405, #538)
+* Add READMEs and XML documentation to all NuGet packages (#844)
 
 ## Bug fixes:
 
-*Contributors of this release (in alphabetical order):* @chekkan
+*Contributors of this release (in alphabetical order):* @304NotModified, @chekkan
 
 # v3.0.3 - 2025-09-17
 

diff --git a/Plugins/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic.csproj b/Plugins/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic.csproj
@@ -6,6 +6,8 @@
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
 
     <PackageId>Reqnroll.Assist.Dynamic</PackageId>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <NuspecFile>$(MSBuildThisFileDirectory)Reqnroll.Assist.Dynamic.nuspec</NuspecFile>
 

diff --git a/Plugins/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic.nuspec b/Plugins/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic.nuspec
@@ -6,6 +6,7 @@
     <title>Reqnroll.Assist.Dynamic</title>
     <authors>Oleg Koshmeliuk,Marcus Hammarberg, $author$</authors>
     <owners>Oleg Koshmeliuk, Marcus Hammarberg, $owner$</owners>
+    <readme>README.md</readme>
     <description>Adds support for dynamic instances and sets from Reqnroll tables. 
 
     See documentation at https://github.com/reqnroll/Reqnroll/tree/main/Plugins/Reqnroll.Assist.Dynamic
@@ -29,8 +30,10 @@
   <files>
     <file src="bin\$config$\netstandard2.0\Reqnroll.Assist.Dynamic.dll" target="lib\netstandard2.0" />
     <file src="bin\$config$\netstandard2.0\Reqnroll.Assist.Dynamic.pdb" target="lib\netstandard2.0" />
+    <file src="bin\$config$\netstandard2.0\Reqnroll.Assist.Dynamic.xml" target="lib\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="../README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>
diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md
@@ -0,0 +1,13 @@
+Reqnroll.Autofac provides [Autofac](https://github.com/autofac/Autofac) dependency injection integration for Reqnroll.
+
+Plugin supports both registration of dependencies globally and per scenario
+
+## Documentation
+
+For more information about using dependency injection with Reqnroll, see [Autofac - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/autofac.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)
diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj
@@ -10,6 +10,8 @@
     <NuspecFile>$(MSBuildThisFileDirectory)Reqnroll.Autofac.nuspec</NuspecFile>
 
     <RootNamespace>Reqnroll.Autofac</RootNamespace>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec
@@ -6,6 +6,7 @@
     <title>Reqnroll Autofac integration plugin</title>
     <authors>Gaspar Nagy, Spec Solutions, $author$</authors>
     <owners>Gaspar Nagy, Spec Solutions, $owner$</owners>
+    <readme>README.md</readme>
     <description>Reqnroll plugin that enables to use Autofac for resolving test dependencies.</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -27,8 +28,10 @@
     <file src="build\**\*" target="build" />
     <file src="bin\$config$\netstandard2.0\Reqnroll.Autofac.ReqnrollPlugin.dll" target="lib\netstandard2.0" />
     <file src="bin\$config$\netstandard2.0\Reqnroll.Autofac.ReqnrollPlugin.pdb" target="lib\netstandard2.0" />
+    <file src="bin\$config$\netstandard2.0\Reqnroll.Autofac.ReqnrollPlugin.xml" target="lib\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>
diff --git a/Plugins/Reqnroll.CustomPlugin/README.md b/Plugins/Reqnroll.CustomPlugin/README.md
@@ -0,0 +1,9 @@
+Reqnroll.CustomPlugin provides a sample custom plugin for Reqnroll.
+
+This package serves as a template and example for creating custom plugins that extend Reqnroll functionality. It demonstrates how to create custom generators, transformations, and other extensions.
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)
diff --git a/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj b/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj
@@ -7,7 +7,8 @@
 
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
     <NoPackageAnalysis>true</NoPackageAnalysis>
-
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec b/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec
@@ -6,6 +6,7 @@
     <title>Reqnroll.CustomPlugin</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package for writing custom generator extensions for Reqnroll.</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -29,6 +30,7 @@
     <file src="$SolutionDir$\Licenses\*" target="Licenses" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 

diff --git a/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md
@@ -0,0 +1,15 @@
+Reqnroll.ExternalData provides external data loading capabilities for Reqnroll scenarios.
+
+The Reqnroll ExternalData plugin lets teams separate test data from test scenarios, and reuse examples across a large set of scenarios. This is particularly helpful when a common set of examples needs to be consistently verified in different scenarios.
+
+Supported Data Sources: CSV, JSON, and excel files
+
+## Documentation
+
+For more information about using external data with Reqnroll, see [External Data Plugin - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/externaldata.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)
diff --git a/...rnalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.ReqnrollPlugin.csproj b/...rnalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.ReqnrollPlugin.csproj
@@ -8,6 +8,8 @@
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 
     <PackageId>Reqnroll.ExternalData</PackageId>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
   </PropertyGroup>
 

diff --git a/...s/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec b/...s/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec
@@ -5,6 +5,7 @@
     <title>Reqnroll.ExternalData</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use external data in Gherkin scenarios</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -24,6 +25,7 @@
     <file src="bin\$config$\netstandard2.0\*" target="build\netstandard2.0"/>
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>
diff --git a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md
@@ -0,0 +1,13 @@
+Reqnroll.MSTest enables using Reqnroll with [MSTest v2 test framework](https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-csharp-with-mstest).
+
+This package provides integration between Reqnroll and MSTest v2, allowing you to write BDD tests using Gherkin syntax that run with the MSTest test framework.
+
+## Documentation
+
+For more information about using Reqnroll with MSTest, visit the [MSTest - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/mstest.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)
diff --git a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec
@@ -6,6 +6,7 @@
     <title>Reqnroll.MsTest</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use Reqnroll for use with MsTest v2. $summary$</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -32,6 +33,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.MSTest.Generator.ReqnrollPlugin.pdb" target="build\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>
diff --git a/Plugins/Reqnroll.MSTest.ReqnrollPlugin/Reqnroll.MSTest.ReqnrollPlugin.csproj b/Plugins/Reqnroll.MSTest.ReqnrollPlugin/Reqnroll.MSTest.ReqnrollPlugin.csproj
@@ -4,6 +4,8 @@
     <AssemblyOriginatorKeyFile>$(Reqnroll_KeyFile)</AssemblyOriginatorKeyFile>
     <SignAssembly>$(Reqnroll_EnableStrongNameSigning)</SignAssembly>
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md
@@ -0,0 +1,13 @@
+Reqnroll.Microsoft.Extensions.DependencyInjection provides [Microsoft.Extensions.DependencyInjection](https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection-usage) integration for Reqnroll.
+
+This package enables Reqnroll to use the standard .NET dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests.
+
+## Documentation
+
+For more information about using dependency injection with Reqnroll, see [Microsoft.Extensions.DependencyInjection - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/dependency-injection.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)
diff --git a/...on.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin.csproj b/...on.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin.csproj
@@ -6,6 +6,8 @@
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
 
     <PackageId>Reqnroll.Microsoft.Extensions.DependencyInjection</PackageId>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <NuspecFile>$(MSBuildThisFileDirectory)Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec</NuspecFile>
 

diff --git a/...pendencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec b/...pendencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec
@@ -6,6 +6,7 @@
     <title>Reqnroll Microsoft.Extensions.DependencyInjection integration plugin</title>
     <authors>Mark Hoek, Solid Token, Stef Heyenrath, $author$</authors>
     <owners>Mark Hoek, Solid Token, Stef Heyenrath, $owner$</owners>
+    <readme>README.md</readme>
     <description>Reqnroll plugin that enables to use Microsoft.Extensions.DependencyInjection for resolving test dependencies.</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -27,8 +28,10 @@
     <file src="build\**\*" target="build" />
     <file src="bin\$config$\netstandard2.0\Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin.dll" target="lib\netstandard2.0" />
     <file src="bin\$config$\netstandard2.0\Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin.pdb" target="lib\netstandard2.0" />
+    <file src="bin\$config$\netstandard2.0\Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin.xml" target="lib\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>
diff --git a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md
@@ -0,0 +1,13 @@
+Reqnroll.NUnit enables using Reqnroll with [NUnit test framework](https://nunit.org/).
+
+This package provides integration between Reqnroll and NUnit, allowing you to write BDD tests using Gherkin syntax that run with the NUnit test framework.
+
+## Documentation
+
+For more information about using Reqnroll with NUnit, see [NUnit - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/nunit.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)
diff --git a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec
@@ -6,6 +6,7 @@
     <title>Reqnroll.NUnit</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use Reqnroll with NUnit 3.13 and later. $summary$</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -26,12 +27,15 @@
 
   <files>
     <file src="build\**\*" exclude="build\*.template.*" target="build" />
-    <file src="bin\$config$\netstandard2.0\Reqnroll.NUnit.ReqnrollPlugin.*" target="lib\netstandard2.0" />
+    <file src="bin\$config$\netstandard2.0\Reqnroll.NUnit.ReqnrollPlugin.dll" target="lib\netstandard2.0" />
+    <file src="bin\$config$\netstandard2.0\Reqnroll.NUnit.ReqnrollPlugin.pdb" target="lib\netstandard2.0" />
+    <file src="bin\$config$\netstandard2.0\Reqnroll.NUnit.ReqnrollPlugin.xml" target="lib\netstandard2.0" />
 
     <file src="bin\$config$\netstandard2.0\Reqnroll.NUnit.Generator.ReqnrollPlugin.dll" target="build\netstandard2.0" />
     <file src="bin\$config$\netstandard2.0\Reqnroll.NUnit.Generator.ReqnrollPlugin.pdb" target="build\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>
diff --git a/Plugins/Reqnroll.NUnit.ReqnrollPlugin/Reqnroll.NUnit.ReqnrollPlugin.csproj b/Plugins/Reqnroll.NUnit.ReqnrollPlugin/Reqnroll.NUnit.ReqnrollPlugin.csproj
@@ -4,6 +4,8 @@
     <AssemblyOriginatorKeyFile>$(Reqnroll_KeyFile)</AssemblyOriginatorKeyFile>
     <SignAssembly>$(Reqnroll_EnableStrongNameSigning)</SignAssembly>
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md
@@ -0,0 +1,9 @@
+Reqnroll.SpecFlowCompatibility provides compatibility layer for migrating from SpecFlow to Reqnroll.
+
+This package helps ease the [migration from SpecFlow](https://docs.reqnroll.net/latest/guides/migrating-from-specflow.html) by providing compatibility shims and adapters, allowing you to gradually migrate your existing SpecFlow tests to Reqnroll.
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)
diff --git a/...roll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec b/...roll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec
@@ -6,6 +6,7 @@
     <title>Reqnroll.SpecFlowCompatibility</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Enables SpecFlow compatibility mode for Reqnroll</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -27,14 +28,18 @@
 
   <files>
     <file src="build\**\*" exclude="build\*.template.*" target="build" />
-    <file src="..\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin\bin\$config$\net462\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.*" target="lib\net462" />
+    <file src="..\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin\bin\$config$\net462\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.dll" target="lib\net462" />
+    <file src="..\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin\bin\$config$\net462\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.pdb" target="lib\net462" />
+    <file src="..\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin\bin\$config$\net462\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.xml" target="lib\net462" />
     <file src="..\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin\bin\$config$\netstandard2.0\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.dll" target="lib\netstandard2.0" />
     <file src="..\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin\bin\$config$\netstandard2.0\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.pdb" target="lib\netstandard2.0" />
+    <file src="..\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin\bin\$config$\netstandard2.0\Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.xml" target="lib\netstandard2.0" />
 
     <file src="bin\$config$\net462\Reqnroll.SpecFlowCompatibility.*" target="build\net462" />
     <file src="bin\$config$\netstandard2.0\Reqnroll.SpecFlowCompatibility.*" target="build\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>
diff --git a/...SpecFlowCompatibility.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.csproj b/...SpecFlowCompatibility.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.csproj
@@ -4,6 +4,8 @@
     <AssemblyOriginatorKeyFile>$(Reqnroll_KeyFile)</AssemblyOriginatorKeyFile>
     <SignAssembly>$(Reqnroll_EnableStrongNameSigning)</SignAssembly>
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/README.md
@@ -0,0 +1,9 @@
+Reqnroll.TUnit enables using Reqnroll with TUnit test framework.
+
+This package provides integration between Reqnroll and [TUnit](https://tunit.dev/), allowing you to write BDD tests using Gherkin syntax that run with the TUnit test framework.
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)
diff --git a/...ns/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.Generator.ReqnrollPlugin.csproj b/...ns/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.Generator.ReqnrollPlugin.csproj
@@ -9,7 +9,8 @@
     <PackageId>Reqnroll.TUnit</PackageId>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <!-- build incorrectly detects a missing content in the 'lib' folder, we need to skip this warning -->
-    <NoWarn>$(NoWarn);NU5128</NoWarn>
+    <NoWarn>$(NoWarn);NU5128;1591</NoWarn>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <PropertyGroup>

diff --git a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec
@@ -6,6 +6,7 @@
     <title>Reqnroll.TUnit</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use Reqnroll with TUnit 0.55.23 and later. $summary$</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -29,8 +30,10 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.TUnit.ReqnrollPlugin.*" target="lib\netstandard2.0" />
     <!-- PDB file for Reqnroll.TUnit.ReqnrollPlugin for source link - needed because of ReferenceOutputAssembly=false -->
     <file src="..\Reqnroll.TUnit.ReqnrollPlugin\bin\$config$\netstandard2.0\Reqnroll.TUnit.ReqnrollPlugin.pdb" target="lib\netstandard2.0" />
+    <file src="..\Reqnroll.TUnit.ReqnrollPlugin\bin\$config$\netstandard2.0\Reqnroll.TUnit.ReqnrollPlugin.xml" target="lib\netstandard2.0" />
     <file src="bin\$config$\netstandard2.0\Reqnroll.TUnit.Generator.ReqnrollPlugin.dll" target="build\netstandard2.0" />
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>
diff --git a/Plugins/Reqnroll.TUnit.ReqnrollPlugin/Reqnroll.TUnit.ReqnrollPlugin.csproj b/Plugins/Reqnroll.TUnit.ReqnrollPlugin/Reqnroll.TUnit.ReqnrollPlugin.csproj
@@ -5,6 +5,8 @@
     <AssemblyOriginatorKeyFile>$(Reqnroll_KeyFile)</AssemblyOriginatorKeyFile>
     <SignAssembly>$(Reqnroll_EnableStrongNameSigning)</SignAssembly>
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
+    <NoWarn>$(NoWarn);1591</NoWarn>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>