From e1bb7c063e74461751f991224af334cfce243a25 Mon Sep 17 00:00:00 2001 From: Jon Sagara Date: Sun, 3 Sep 2023 17:08:32 -0700 Subject: [PATCH 1/3] Added a readme and a license. --- LICENSE.md | 9 +++++++++ README.md | 6 ++++++ 2 files changed, 15 insertions(+) create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..438008a --- /dev/null +++ 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 new file mode 100644 index 0000000..42d6126 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# Sagara.Core + +[![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) +[![NuGet](https://img.shields.io/nuget/vpre/Sagara.Core.svg?label=NuGet)](https://www.nuget.org/packages/Sagara.Core/) + +This is 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. From 9584f9fb48582dc1e2141d75f8747733c39c958b Mon Sep 17 00:00:00 2001 From: Jon Sagara Date: Sun, 3 Sep 2023 17:10:26 -0700 Subject: [PATCH 2/3] Link the README and LICENSE files. --- Sagara.Core.sln | 3 ++- src/Sagara.Core/Sagara.Core.csproj | 10 +++++----- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/Sagara.Core.sln b/Sagara.Core.sln index a13f1d0..90faa16 100644 --- 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/Sagara.Core.csproj b/src/Sagara.Core/Sagara.Core.csproj index 03b5aa1..ce30136 100644 --- a/src/Sagara.Core/Sagara.Core.csproj +++ b/src/Sagara.Core/Sagara.Core.csproj @@ -8,8 +8,8 @@ Sagara.Core Common classes that I reuse in my projects. - - + LICENSE.md + README.md Validation SequentialGuid Caching Enums @@ -21,11 +21,11 @@ True - - --> + From 61ce5ddd974f80489e78996dc1563b332ffecfd1 Mon Sep 17 00:00:00 2001 From: Jon Sagara Date: Sun, 3 Sep 2023 17:19:12 -0700 Subject: [PATCH 3/3] Added individual READMEs for each package. --- README.md | 18 +++++++++++++++--- src/Sagara.Core.Caching/README.md | 3 +++ .../Sagara.Core.Caching.csproj | 10 ++++++++-- src/Sagara.Core.Logging.Serilog/README.md | 3 +++ .../Sagara.Core.Logging.Serilog.csproj | 10 ++++++++-- src/Sagara.Core/README.md | 3 +++ src/Sagara.Core/Sagara.Core.csproj | 2 +- 7 files changed, 41 insertions(+), 8 deletions(-) create mode 100644 src/Sagara.Core.Caching/README.md create mode 100644 src/Sagara.Core.Logging.Serilog/README.md create mode 100644 src/Sagara.Core/README.md diff --git a/README.md b/README.md index 42d6126..a31cf3c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,18 @@ -# Sagara.Core +# 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) -[![NuGet](https://img.shields.io/nuget/vpre/Sagara.Core.svg?label=NuGet)](https://www.nuget.org/packages/Sagara.Core/) -This is 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. +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/src/Sagara.Core.Caching/README.md b/src/Sagara.Core.Caching/README.md new file mode 100644 index 0000000..3324487 --- /dev/null +++ b/src/Sagara.Core.Caching/README.md @@ -0,0 +1,3 @@ +# Sagara.Core.Caching + +TODO: elaborate \ No newline at end of file diff --git a/src/Sagara.Core.Caching/Sagara.Core.Caching.csproj b/src/Sagara.Core.Caching/Sagara.Core.Caching.csproj index caae9a3..e4018a5 100644 --- a/src/Sagara.Core.Caching/Sagara.Core.Caching.csproj +++ b/src/Sagara.Core.Caching/Sagara.Core.Caching.csproj @@ -8,8 +8,8 @@ Sagara.Core.Caching Common caching functionality for redis. - - + LICENSE.md + README.md redis caching @@ -24,6 +24,12 @@ $(NoWarn);CA1848 + + + + + + diff --git a/src/Sagara.Core.Logging.Serilog/README.md b/src/Sagara.Core.Logging.Serilog/README.md new file mode 100644 index 0000000..339e58c --- /dev/null +++ b/src/Sagara.Core.Logging.Serilog/README.md @@ -0,0 +1,3 @@ +# Sagara.Core.Logging.Serilog + +TODO: elaborate \ No newline at end of file diff --git a/src/Sagara.Core.Logging.Serilog/Sagara.Core.Logging.Serilog.csproj b/src/Sagara.Core.Logging.Serilog/Sagara.Core.Logging.Serilog.csproj index 7c0b792..f39e2cc 100644 --- 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 @@ Sagara.Core.Logging.Serilog Common Serilog functionality. - - + LICENSE.md + README.md serilog logging @@ -24,6 +24,12 @@ + + + + + + diff --git a/src/Sagara.Core/README.md b/src/Sagara.Core/README.md new file mode 100644 index 0000000..45ca225 --- /dev/null +++ b/src/Sagara.Core/README.md @@ -0,0 +1,3 @@ +# Sagara.Core + +TODO: elaborate \ No newline at end of file diff --git a/src/Sagara.Core/Sagara.Core.csproj b/src/Sagara.Core/Sagara.Core.csproj index ce30136..ac8f8ee 100644 --- a/src/Sagara.Core/Sagara.Core.csproj +++ b/src/Sagara.Core/Sagara.Core.csproj @@ -24,7 +24,7 @@ - +