Merge pull request #3 from osisdie/doc/refactor

Prepare v1.0.0: MIT license, centralized NuGet metadata, .NET 11 CI

Author: osisdie

.github/workflows/dotnet.yml

@@ -9,10 +9,16 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental || false }}
 
     strategy:
+      fail-fast: false
       matrix:
-        dotnet-version: ['8.0.x', '10.0.x']
+        dotnet-version: ['8.0.x', '10.0.x', '11.0.x']
+        include:
+          - dotnet-version: '11.0.x'
+            experimental: true
+            prerelease: true
 
     steps:
       - uses: actions/checkout@v4
@@ -21,6 +27,7 @@ jobs:
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: ${{ matrix.dotnet-version }}
+          include-prerelease: ${{ matrix.prerelease || false }}
 
       - name: Restore dependencies
         run: dotnet restore

.github/workflows/nuget-publish.yml

@@ -0,0 +1,35 @@
+name: NuGet Publish
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0.x'
+
+      - name: Restore
+        run: dotnet restore
+
+      - name: Build
+        run: dotnet build --configuration Release --no-restore
+
+      - name: Pack
+        run: dotnet pack --configuration Release --no-build --output ./nupkgs
+
+      - name: Push to NuGet
+        run: dotnet nuget push "./nupkgs/*.nupkg" --api-key "$NUGET_API_KEY" --source https://api.nuget.org/v3/index.json --skip-duplicate
+        env:
+          NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a welcoming experience for everyone.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior:
+
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Publishing others' private information without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of unacceptable behavior may be reported to the project maintainers via
+[GitHub Issues](https://github.com/osisdie/dotnet-nwpie-foundation-sdk/issues).
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

CONTRIBUTING.md

@@ -1,18 +1,18 @@
-# Contributing to Nwpie.Foundation.NetCore.SDK
+# Contributing to dotnet-nwpie-foundation-sdk
 
 Thank you for your interest in contributing! Here's how to get started.
 
 ## Development Setup
 
 ```bash
-git clone https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK.git
-cd Nwpie.Foundation.NetCore.SDK
+git clone https://github.com/osisdie/dotnet-nwpie-foundation-sdk.git
+cd dotnet-nwpie-foundation-sdk
 dotnet restore
 dotnet build
 dotnet test
 ```
 
-**Prerequisites**: .NET 8 SDK
+**Prerequisites**: .NET 8 SDK (or later)
 
 ## How to Contribute
 
@@ -35,7 +35,7 @@ build/          # Build scripts and configurations
 ## Coding Guidelines
 
 - **Library projects** target `netstandard2.1` for broad compatibility
-- **Application projects** (endpoints, lambdas) target `net8.0`
+- **Application projects** (endpoints, lambdas) multi-target `net8.0` and `net10.0`
 - Follow existing naming conventions and code style
 - Add unit tests for new functionality
 - Keep modules self-contained and loosely coupled
@@ -47,4 +47,4 @@ build/          # Build scripts and configurations
 
 ## License
 
-By contributing, you agree that your contributions will be licensed under the [BSD-3-Clause License](LICENSE).
+By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).

Directory.Build.props

@@ -0,0 +1,12 @@
+<Project>
+  <PropertyGroup>
+    <VersionPrefix>1.0.0</VersionPrefix>
+    <Authors>kevinwu</Authors>
+    <Copyright>Copyright (c) 2019-2026 Kevin Wu</Copyright>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
+    <PackageProjectUrl>https://github.com/osisdie/dotnet-nwpie-foundation-sdk</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/osisdie/dotnet-nwpie-foundation-sdk</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
+  </PropertyGroup>
+</Project>

LICENSE

@@ -1,28 +1,21 @@
-BSD 3-Clause License
+MIT License
 
-Copyright (c) 2019-2026, Kevin Wu
+Copyright (c) 2019-2026 Kevin Wu
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+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:
 
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+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.

README.md

@@ -1,16 +1,20 @@
 # Nwpie.Foundation.NetCore.SDK
 
-[![.NET](https://img.shields.io/badge/.NET-8%20%7C%2010-blue.svg)](https://dotnet.microsoft.com/download/dotnet)
-[![License](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg)](LICENSE)
-[![Build](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/actions/workflows/dotnet.yml/badge.svg)](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/actions/workflows/dotnet.yml)
-[![GitHub stars](https://img.shields.io/github/stars/osisdie/Nwpie.Foundation.NetCore.SDK)](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/stargazers)
-[![GitHub issues](https://img.shields.io/github/issues/osisdie/Nwpie.Foundation.NetCore.SDK)](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/issues)
-[![Last commit](https://img.shields.io/github/last-commit/osisdie/Nwpie.Foundation.NetCore.SDK)](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/commits/main)
+[![.NET](https://img.shields.io/badge/.NET-8%20%7C%2010%20%7C%2011--preview-blue.svg)](https://dotnet.microsoft.com/download/dotnet)
+[![NuGet](https://img.shields.io/nuget/v/Nwpie.Foundation.Abstractions.svg)](https://www.nuget.org/packages?q=Nwpie.Foundation)
+[![netstandard2.1](https://img.shields.io/badge/netstandard-2.1-blue.svg)](https://docs.microsoft.com/en-us/dotnet/standard/net-standard)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Build](https://github.com/osisdie/dotnet-nwpie-foundation-sdk/actions/workflows/dotnet.yml/badge.svg)](https://github.com/osisdie/dotnet-nwpie-foundation-sdk/actions/workflows/dotnet.yml)
+[![Modules](https://img.shields.io/badge/modules-16-green.svg)](#modules-overview)
+[![GitHub stars](https://img.shields.io/github/stars/osisdie/dotnet-nwpie-foundation-sdk)](https://github.com/osisdie/dotnet-nwpie-foundation-sdk/stargazers)
+[![GitHub issues](https://img.shields.io/github/issues/osisdie/dotnet-nwpie-foundation-sdk)](https://github.com/osisdie/dotnet-nwpie-foundation-sdk/issues)
+[![Last commit](https://img.shields.io/github/last-commit/osisdie/dotnet-nwpie-foundation-sdk)](https://github.com/osisdie/dotnet-nwpie-foundation-sdk/commits/main)
 
 **Nwpie.Foundation.NetCore.SDK** is a comprehensive, modular SDK built for .NET developers. It simplifies and enhances application development by providing an all-in-one solution with well-defined abstractions, robust utilities, and modularized components. Core libraries target `netstandard2.1` for broad compatibility, while endpoint and test projects multi-target `net8.0` and `net10.0`. Fully supported with unit tests.
 
 ## Table of Contents
 - [Features](#features)
+- [Installation](#installation)
 - [Modules Overview](#modules-overview)
 - [Quick Start](#quick-start)
 - [Getting Started](#getting-started)
@@ -23,13 +27,35 @@
 ---
 
 ## Features
-- **Multi-target .NET 8 & .NET 10**: Endpoint and test projects target both `net8.0` and `net10.0`. Core libraries use `netstandard2.1` for broad compatibility.
+- **Multi-target .NET 8, .NET 10 & .NET 11 (preview)**: Endpoint and test projects target `net8.0` and `net10.0`. CI also validates against .NET 11 preview. Core libraries use `netstandard2.1` for broad compatibility.
 - **Modular SDK**: Use what you need with a modularized structure.
+- **NuGet Ready**: Install individual modules via NuGet for easy integration.
 - **Comprehensive Tests**: Unit tests demonstrate usage and ensure reliability.
 - **Extensive Utilities**: Includes tools for logging, configuration, data access, and more.
 
 ---
 
+## Installation
+
+Install individual modules via NuGet:
+
+```bash
+dotnet add package Nwpie.Foundation.Abstractions
+dotnet add package Nwpie.Foundation.Common
+dotnet add package Nwpie.Foundation.Caching.Common
+dotnet add package Nwpie.Foundation.Caching.Redis
+dotnet add package Nwpie.Foundation.Auth.SDK
+dotnet add package Nwpie.Foundation.Http.Common
+```
+
+Or search for all available packages:
+
+```bash
+dotnet nuget search Nwpie.Foundation
+```
+
+---
+
 ## Modules Overview
 The SDK provides the following modules, located under the `src/` directory:
 
@@ -103,8 +129,8 @@ See the [samples/](samples/) directory for complete working examples (MiniSite,
 Clone the repository to explore the SDK:
 
 ```bash
-git clone https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK.git
-cd Nwpie.Foundation.NetCore.SDK
+git clone https://github.com/osisdie/dotnet-nwpie-foundation-sdk.git
+cd dotnet-nwpie-foundation-sdk
 ```
 
 ### Explore Modules
@@ -117,7 +143,7 @@ Modules are located in the `src/` directory. For example:
 Each module is self-contained and can be used independently or as part of the complete SDK.
 
 ### Run Unit Tests
-Unit tests demonstrate how to use each module. Tests are located under `test/UnitTest`.
+Unit tests demonstrate how to use each module. Tests are located under `tests/UnitTest`.
 
 To run the tests:
 
@@ -138,9 +164,9 @@ We welcome contributions from the open-source community! See [CONTRIBUTING.md](C
 ---
 
 ## License
-This project is licensed under the BSD-3-Clause License. See the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
 
 ---
 
 ## Support
-If you encounter any issues or have suggestions, feel free to open an [issue](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/issues) on GitHub.
+If you encounter any issues or have suggestions, feel free to open an [issue](https://github.com/osisdie/dotnet-nwpie-foundation-sdk/issues) on GitHub.

SECURITY.md

@@ -0,0 +1,33 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | .NET Target      | Supported          |
+|---------|------------------|--------------------|
+| 1.0.x   | netstandard2.1   | Yes                |
+| 1.0.x   | net8.0           | Yes                |
+| 1.0.x   | net10.0          | Yes                |
+| -       | net11.0 (preview)| No (preview only)  |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in this project, please report it responsibly:
+
+1. **Do NOT open a public GitHub issue** for security vulnerabilities
+2. Use [GitHub Security Advisories](https://github.com/osisdie/dotnet-nwpie-foundation-sdk/security/advisories/new) to report privately
+3. Alternatively, contact the maintainer directly
+
+### What to expect
+
+- Acknowledgment within 48 hours
+- Status update within 7 days
+- We will work with you to understand and address the issue
+
+## Security Best Practices
+
+When using this SDK:
+
+- Keep dependencies up to date
+- Never commit secrets, API keys, or credentials to source control
+- Use the `.env.example` file as a template; store actual secrets in environment variables or a secrets manager
+- Review the [CONTRIBUTING.md](CONTRIBUTING.md) for secure development guidelines

samples/MiniSite/ESProxy/Contract/Nwpie.MiniSite.ES.Contract.csproj

@@ -2,17 +2,11 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
+    <IsPackable>false</IsPackable>
     <PackageId>Nwpie.MiniSite.ES.Contract</PackageId>
-    <Authors>kevinwu</Authors>
-    <License>https://www.freebsd.org/copyright/freebsd-license.html</License>
     <Description>SDK/Helper/Cloud/Utility</Description>
     <PackageTags>ES;Contract</PackageTags>
     <PackageReleaseNotes>Reference Abstractions</PackageReleaseNotes>
-    <PackageIconUrl>https://cdn.vsassets.io/content/icons/favicon.ico</PackageIconUrl>
-    <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
-    <RepositoryType>git</RepositoryType>
-    <VersionPrefix>1.0.0.0</VersionPrefix>
-    <!--VersionSuffix>preview-0723-2</VersionSuffix-->
   </PropertyGroup>
 
   <ItemGroup>

samples/MiniSite/ESProxy/Endpoint/Nwpie.MiniSite.ES.Endpoint.csproj

@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>net8.0;net10.0</TargetFrameworks>
+    <IsPackable>false</IsPackable>
     <EnableDefaultContentItems>false</EnableDefaultContentItems>
   </PropertyGroup>