Merge pull request #1 from jonsagara/feature/readme

Feature/readme
jonsagara · Sep 4, 2023 · bb89c15 · bb89c15
2 parents 1baad25 + 61ce5dd
commit bb89c15
Show file tree

Hide file tree

Showing 9 changed files with 60 additions and 11 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 Jon Sagara
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# Sagara.Core NuGet Packages
+
+[![publish](https://github.com/jonsagara/Sagara.Core/actions/workflows/build-and-publish.yml/badge.svg)](https://github.com/jonsagara/Sagara.Core/actions?query=workflow%3Apublish)
+
+These assemblies contain common code that I have found useful over the years, particularly when bootstrapping small 
+proof-of-concept or bug demonstration applications. It reduces the amount of boilerplate code needed to be productive.
+
+## Sagara.Core
+
+[![NuGet](https://img.shields.io/nuget/vpre/Sagara.Core.svg?label=Sagara.Core)](https://www.nuget.org/packages/Sagara.Core/)
+
+## Sagara.Core.Caching
+
+[![NuGet](https://img.shields.io/nuget/vpre/Sagara.Core.Caching.svg?label=Sagara.Core.Caching)](https://www.nuget.org/packages/Sagara.Core.Caching/)
+
+## Sagara.Core.Logging.Serilog
+
+[![NuGet](https://img.shields.io/nuget/vpre/Sagara.Core.Logging.Serilog.svg?label=Sagara.Core.Logging.Serilog)](https://www.nuget.org/packages/Sagara.Core.Logging.Serilog/)
diff --git a/Sagara.Core.sln b/Sagara.Core.sln
@@ -9,13 +9,14 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		Directory.Build.props = Directory.Build.props
 		global.json = global.json
 		nuget.config = nuget.config
+		README.md = README.md
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sagara.Core", "src\Sagara.Core\Sagara.Core.csproj", "{391401C7-8631-4004-8E30-976C29973EFA}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sagara.Core.Caching", "src\Sagara.Core.Caching\Sagara.Core.Caching.csproj", "{4C42CB44-AA11-4DAB-AE5A-0C8D195BFDE3}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sagara.Core.Logging.Serilog", "src\Sagara.Core.Logging.Serilog\Sagara.Core.Logging.Serilog.csproj", "{D2762B2D-1CD6-4FAC-BF28-FDA752F029BC}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sagara.Core.Logging.Serilog", "src\Sagara.Core.Logging.Serilog\Sagara.Core.Logging.Serilog.csproj", "{D2762B2D-1CD6-4FAC-BF28-FDA752F029BC}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

diff --git a/src/Sagara.Core.Caching/README.md b/src/Sagara.Core.Caching/README.md
@@ -0,0 +1,3 @@
+# Sagara.Core.Caching
+
+TODO: elaborate
diff --git a/src/Sagara.Core.Caching/Sagara.Core.Caching.csproj b/src/Sagara.Core.Caching/Sagara.Core.Caching.csproj
@@ -8,8 +8,8 @@
 		<!-- NuGet -->
 		<PackageId>Sagara.Core.Caching</PackageId>
 		<Description>Common caching functionality for redis.</Description>
-		<!--<PackageLicenseFile>LICENSE.md</PackageLicenseFile>-->
-		<!--<PackageReadmeFile>README.md</PackageReadmeFile>-->
+		<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
+		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<!--<PackageIcon>NuGet Package Icon.png</PackageIcon>-->
 		<PackageTags>redis caching</PackageTags>
 		<PackageReleaseNotes></PackageReleaseNotes>
@@ -24,6 +24,12 @@
 		<NoWarn>$(NoWarn);CA1848</NoWarn>
 	</PropertyGroup>
 
+	<ItemGroup>
+		<!--<None Include="..\..\NuGet Package Icon.png" Pack="true" PackagePath="\" />-->
+		<None Include="..\..\LICENSE.md" Pack="true" PackagePath="" />
+		<None Include=".\README.md" Pack="true" PackagePath="\" />
+	</ItemGroup>
+
 	<ItemGroup>
 		<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="7.0.0" />
 		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.1" />

diff --git a/src/Sagara.Core.Logging.Serilog/README.md b/src/Sagara.Core.Logging.Serilog/README.md
@@ -0,0 +1,3 @@
+# Sagara.Core.Logging.Serilog
+
+TODO: elaborate
diff --git a/src/Sagara.Core.Logging.Serilog/Sagara.Core.Logging.Serilog.csproj b/src/Sagara.Core.Logging.Serilog/Sagara.Core.Logging.Serilog.csproj
@@ -8,8 +8,8 @@
 		<!-- NuGet -->
 		<PackageId>Sagara.Core.Logging.Serilog</PackageId>
 		<Description>Common Serilog functionality.</Description>
-		<!--<PackageLicenseFile>LICENSE.md</PackageLicenseFile>-->
-		<!--<PackageReadmeFile>README.md</PackageReadmeFile>-->
+		<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
+		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<!--<PackageIcon>NuGet Package Icon.png</PackageIcon>-->
 		<PackageTags>serilog logging</PackageTags>
 		<PackageReleaseNotes></PackageReleaseNotes>
@@ -24,6 +24,12 @@
 		<!--<NoWarn>$(NoWarn);CA1848</NoWarn>-->
 	</PropertyGroup>
 
+	<ItemGroup>
+		<!--<None Include="..\..\NuGet Package Icon.png" Pack="true" PackagePath="\" />-->
+		<None Include="..\..\LICENSE.md" Pack="true" PackagePath="" />
+		<None Include=".\README.md" Pack="true" PackagePath="\" />
+	</ItemGroup>
+
 	<ItemGroup>
 		<PackageReference Include="Microsoft.Extensions.Hosting" Version="7.0.1" />
 		<PackageReference Include="Serilog" Version="3.0.1" />

diff --git a/src/Sagara.Core/README.md b/src/Sagara.Core/README.md
@@ -0,0 +1,3 @@
+# Sagara.Core
+
+TODO: elaborate
diff --git a/src/Sagara.Core/Sagara.Core.csproj b/src/Sagara.Core/Sagara.Core.csproj
@@ -8,8 +8,8 @@
 		<!-- NuGet -->
 		<PackageId>Sagara.Core</PackageId>
 		<Description>Common classes that I reuse in my projects.</Description>
-		<!--<PackageLicenseFile>LICENSE.md</PackageLicenseFile>-->
-		<!--<PackageReadmeFile>README.md</PackageReadmeFile>-->
+		<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
+		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<!--<PackageIcon>NuGet Package Icon.png</PackageIcon>-->
 		<PackageTags>Validation SequentialGuid Caching Enums</PackageTags>
 		<PackageReleaseNotes></PackageReleaseNotes>
@@ -21,11 +21,11 @@
 		<GenerateDocumentationFile>True</GenerateDocumentationFile>
 	</PropertyGroup>
 
-	<!--<ItemGroup>
-		<None Include="..\..\NuGet Package Icon.png" Pack="true" PackagePath="\" />
+	<ItemGroup>
+		<!--<None Include="..\..\NuGet Package Icon.png" Pack="true" PackagePath="\" />-->
 		<None Include="..\..\LICENSE.md" Pack="true" PackagePath="" />
-		<None Include="..\..\README.md" Pack="true" PackagePath="\" />
-	</ItemGroup>-->
+		<None Include=".\README.md" Pack="true" PackagePath="\" />
+	</ItemGroup>
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.IO.RecyclableMemoryStream" Version="2.3.2" />