Merge pull request #433 from baynezy/feature/issue-342-readme

Add README to the NuGet package
baynezy · Aug 2, 2024 · 3f5673f · 3f5673f
2 parents 86d8667 + 6c84bf2
commit 3f5673f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,8 +13,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add missing XML docs for classes and methods
+- Added missing XML docs for classes and methods
 - Pushing beta packages to NuGet from `develop` branch
+- Added README to NuGet package 
 
 ## [6.2.1.4] - 2024-05-07
 
@@ -33,7 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added stale issue workflow
 - Added allowing strong and b tags to have properties
-- Modified all `IReplacers` to have to have their own concrete implementation
+- Modified all `IReplacers` to have their own concrete implementation
 
 ### Fixed
 

diff --git a/README.md b/README.md
@@ -8,9 +8,9 @@ Converts HTML to [Markdown](http://daringfireball.net/projects/markdown/syntax).
 
 ## Build Status
 
-| Branch | Status                                                                                                                                                                                              |
-| ------ |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `master` | [![master](https://github.com/baynezy/Html2Markdown/actions/workflows/branch-master.yml/badge.svg?branch=master)](https://github.com/baynezy/Html2Markdown/actions/workflows/branch-master.yml)     |
+| Branch    | Status                                                                                                                                                                                              |
+|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `master`  | [![master](https://github.com/baynezy/Html2Markdown/actions/workflows/branch-master.yml/badge.svg?branch=master)](https://github.com/baynezy/Html2Markdown/actions/workflows/branch-master.yml)     |
 | `develop` | [![develop](https://github.com/baynezy/Html2Markdown/actions/workflows/branch-develop.yml/badge.svg?branch=develop)](https://github.com/baynezy/Html2Markdown/actions/workflows/branch-develop.yml) |
 
 ## Support

diff --git a/src/Html2Markdown/Html2Markdown.csproj b/src/Html2Markdown/Html2Markdown.csproj
@@ -5,17 +5,22 @@
     <Authors>Simon Baynes</Authors>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/baynezy/Html2Markdown</PackageProjectUrl>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <Description>A library for converting HTML to markdown syntax in C#</Description>
     <Copyright>© Simon Baynes 2013</Copyright>
     <PackageTags>Markdown;Html;Convert</PackageTags>
     <SignAssembly>True</SignAssembly>
     <AssemblyOriginatorKeyFile>Html2Markdown.snk</AssemblyOriginatorKeyFile>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
-
+  
   <ItemGroup>
     <PackageReference Include="HtmlAgilityPack" Version="1.11.62" />
     <PackageReference Include="JetBrains.Annotations" Version="2024.2.0" />
   </ItemGroup>
+
+  <ItemGroup>
+    <None Include="../../README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
 
 </Project>