Added READMEs

2025-02-18 21:48:14 +00:00
parent c0bc8ff760
commit fd2600863e
4 changed files with 30 additions and 0 deletions
@@ -4,6 +4,17 @@
        <TargetFramework>netstandard2.1</TargetFramework>
        <ImplicitUsings>disable</ImplicitUsings>
        <Nullable>enable</Nullable>
+        <Title>Omega Leo's Helper Library - Changelog</Title>
+        <Authors>Nuno "Omega Leo" Diogo</Authors>
+        <Description>Package to help with Changelog generation</Description>
+        <PackageProjectUrl>https://github.com/omegaleo/HelperLib</PackageProjectUrl>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+        <RepositoryUrl>https://github.com/omegaleo/HelperLib</RepositoryUrl>
    </PropertyGroup>

+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
+        <None Include="CHANGELOG.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
+
 </Project>
@@ -0,0 +1,12 @@
+# Omega Leo's Helper Library - Changelog
+Package to help with Changelog generation by providing a new Changelog attribute and a tool to extract a dictionary of the changelogs or the markdown for CHANGELOG.md
+
+Example attribute usage:
+```cs
+[Changelog("v1.0.0", "This is a test")]
+[Changelog("v1.0.1", "This is another test")]
+public class Test
+{
+    
+}
+```
@@ -7,6 +7,7 @@
        <Version>0.0.2</Version>
        <Title>Omega Leo's Helper Library</Title>
        <Authors>Nuno "Omega Leo" Diogo</Authors>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
        <PackageProjectUrl>https://github.com/omegaleo/HelperLib</PackageProjectUrl>
        <RepositoryUrl>https://github.com/omegaleo/HelperLib</RepositoryUrl>
    </PropertyGroup>
@@ -15,4 +16,9 @@
      <PackageReference Include="NetFlow.DocumentationHelper.Library" Version="1.1.2" />
    </ItemGroup>

+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
+        <None Include="CHANGELOG.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
+
 </Project>
@@ -0,0 +1 @@
+# Omega Leo's Helper Lib