Add copy template quick link in README

Author: marko-stanojevic

README.md

@@ -1,36 +1,48 @@
 # PSScriptModule.Template
 
-A production-ready PowerShell script module template designed to streamline the creation, testing, and delivery of enterprise-grade PowerShell modules. This template implements modern DevOps practices, automated quality gates, and continuous delivery workflows right out of the box.
+A production-ready PowerShell script module template designed to streamline the creation, testing, and delivery of enterprise-grade PowerShell modules. This template implements modern DevOps practices,
+automated quality gates, and continuous delivery workflows right out of the box.
 
 [![CI](https://github.com/WarehouseFinds/PSScriptModule/actions/workflows/ci.yml/badge.svg)](https://github.com/WarehouseFinds/PSScriptModule/actions/workflows/ci.yml)
 [![PowerShell Gallery](https://img.shields.io/powershellgallery/v/PSScriptModule.svg)](https://www.powershellgallery.com/packages/PSScriptModule)
-[![License](https://img.shields.io/github/license/WarehouseFinds/PSScriptModule.Template)](LICENSE)
+[![License](https://img.shields.io/github/license/WarehouseFinds/PSScriptModule)](LICENSE)
 
 ## 🎯 Purpose
 
-This template solves the common challenge of setting up a professional PowerShell module project from scratch. Instead of manually configuring build scripts, testing frameworks, and CI/CD pipelines, you can clone this repository and start writing your module's business logic immediately.
+This template solves the common challenge of setting up a professional PowerShell module project from scratch. Instead of manually configuring build scripts, testing frameworks, and CI/CD pipelines,
+you can clone this repository and start writing your module's business logic immediately.
 
 **Perfect for:**
-- 🏢 Enterprise PowerShell module development
+
 - 📦 Open-source PowerShell projects
 - 🔧 DevOps automation tools
 - 🎓 Learning PowerShell module development best practices
 
+## How to Use This Template
+
+Simply copy the template to your account, then give bootstrap action **about 20 seconds** to prepare the repository for you, then **refresh the page**.
+The name and description will be automatically set based on your inputs.
+
+[![](https://img.shields.io/badge/Copy%20Powershell%20Module-%E2%86%92-1f883d?style=for-the-badge&logo=github&labelColor=197935)](https://github.com/new?template_owner=WarehouseFinds&template_name=PSScriptModule&owner=%40me&name=PS-&description=PS%20Module%20Template&visibility=public)
+
 ## ✨ Key Features
 
 ### 🏗️ Structured Project Layout
+
 - **Clear separation of concerns** with dedicated folders for source code, tests, and documentation
 - **Public/Private function organization** for proper encapsulation
 - **Module manifest (`.psd1`)** with all necessary metadata
 - **Standardized naming conventions** for consistency
 
 ### 🔨 Automated Build System
+
 - **Invoke-Build orchestration** with predefined build tasks
 - **ModuleBuilder integration** for compiling script modules
 - **Automated module packaging** ready for distribution
 - **Debug and Release configurations** for different build scenarios
 
 ### 🧪 Comprehensive Testing
+
 - **Pester 5+ testing framework** for unit tests
 - **Code coverage reporting** (Cobertura format)
 - **PSScriptAnalyzer integration** for static code analysis
@@ -39,18 +51,21 @@ This template solves the common challenge of setting up a professional PowerShel
 - **Test results in NUnit XML format** for CI/CD integration
 
 ### 📚 Documentation Generation
+
 - **PlatyPS integration** for markdown-based help
 - **Automated MAML generation** for Get-Help support
 - **External help files** (`.xml`) for PowerShell's built-in help system
 - **Example-driven documentation** templates
 
 ### 🔄 Automated Versioning
+
 - **GitVersion** for semantic versioning based on git history
 - **GitHub Flow workflow** for streamlined releases
 - **Commit-based version control** using `+semver:` keywords
 - **Automatic version updates** in module manifest
 
 ### 🚀 CI/CD Ready
+
 - **Pre-configured GitHub Actions** workflows
 - **Automated quality gates** (tests, analysis, security scans)
 - **Automated releases** on PR merges to main
@@ -59,13 +74,14 @@ This template solves the common challenge of setting up a professional PowerShel
 - **Manual workflow dispatch** with version control and publishing options
 
 ### 📦 Dependency Management
+
 - **PSDepend** for managing module dependencies
 - **Version-pinned dependencies** for reproducible builds
 - **Automatic dependency installation** in CI/CD pipelines
 
 ## 📂 Project Structure
 
-```
+```plaintext
 PSScriptModule.Template/
 ├── 📄 PSScriptModule.build.ps1      # Invoke-Build script with all build tasks
 ├── 📄 requirements.psd1             # PSDepend configuration for dependencies
@@ -105,12 +121,14 @@ PSScriptModule.Template/
 ### Quick Start
 
 1. **Clone or use this template:**
+
    ```bash
    git clone https://github.com/WarehouseFinds/PSScriptModule.Template.git MyModule
    cd MyModule
    ```
 
 2. **Install dependencies:**
+
    ```powershell
    # Install PSDepend if not already installed
    Install-Module -Name PSDepend -Scope CurrentUser -Force
@@ -120,11 +138,13 @@ PSScriptModule.Template/
    ```
 
 3. **Customize the module:**
+
    - Update `src/PSScriptModule.psd1` with your module information
    - Rename files and folders from `PSScriptModule` to your module name
    - Add your functions to `src/Public/` and `src/Private/`
 
 4. **Build and test:**
+
    ```powershell
    # Run default build (Clean + Build)
    Invoke-Build
@@ -185,6 +205,7 @@ Invoke-Pester -Configuration @{
 ### Test Output
 
 All test results are saved to `test-results/` directory:
+
 - `unit-tests.xml` - Pester test results (NUnit XML)
 - `code-coverage.xml` - Code coverage report (Cobertura)
 - `static-code-analysis.xml` - PSScriptAnalyzer results
@@ -200,6 +221,7 @@ Invoke-Build Export-CommandHelp
 ```
 
 Help files are generated in two formats:
+
 1. **Markdown** (`.md`) - Stored in `docs/help/` for web/GitHub viewing
 2. **MAML** (`.xml`) - Stored in module's `en-US/` folder for `Get-Help` command
 
@@ -242,7 +264,7 @@ The CI workflow orchestrates multiple jobs in parallel:
 The pipeline automatically determines the build type:
 
 | Event | Build Type | Version Format | Published |
-|-------|-----------|----------------|-----------|
+| --------- | ---------------- | --------- |
 | Pull Request | Debug | `1.2.3-PullRequest1234` | No |
 | Push to main | Prerelease | `1.2.3-Prerelease` | Yes |
 | Manual (workflow_dispatch) | Release | `1.2.3` | Optional |
@@ -262,7 +284,7 @@ This template uses **Semantic Versioning** (SemVer) with automated version manag
 Include one of these keywords in your commit message:
 
 | Keyword | Version Change | Example |
-|---------|----------------|---------|
+| --------- | ---------------- | --------- |
 | `+semver: breaking` or `+semver: major` | Major (1.0.0 → 2.0.0) | Breaking changes |
 | `+semver: feature` or `+semver: minor` | Minor (1.0.0 → 1.1.0) | New features |
 | `+semver: fix` or `+semver: patch` | Patch (1.0.0 → 1.0.1) | Bug fixes |
@@ -282,6 +304,7 @@ git commit -m "Update README +semver: none"
 ### Creating New Functions
 
 1. **Create function file** in `src/Public/` or `src/Private/`:
+
    ```powershell
    # src/Public/Get-Something.ps1
    function Get-Something {
@@ -310,6 +333,7 @@ git commit -m "Update README +semver: none"
    ```
 
 2. **Create test file** alongside function:
+
    ```powershell
    # src/Public/Get-Something.Tests.ps1
    BeforeAll {
@@ -325,12 +349,14 @@ git commit -m "Update README +semver: none"
    ```
 
 3. **Update module manifest** if adding public function:
+
    ```powershell
    # Add to FunctionsToExport in PSScriptModule.psd1
    FunctionsToExport = @('Get-PSScriptModuleInfo', 'Get-Something')
    ```
 
 4. **Build and test**:
+
    ```powershell
    Invoke-Build Test
    ```
@@ -355,6 +381,7 @@ Invoke-Build -ReleaseType Release -NugetApiKey 'YOUR-API-KEY'
 ### Automated Publishing (CI/CD)
 
 Configure your GitHub repository secrets:
+
 - `NUGETAPIKEY_PSGALLERY` - Your PowerShell Gallery API key
 
 The CI/CD pipeline will automatically publish on release.
@@ -364,19 +391,21 @@ The CI/CD pipeline will automatically publish on release.
 You can manually trigger builds and releases via GitHub Actions workflow dispatch:
 
 1. **Navigate to Actions** → CI workflow
-2. **Click "Run workflow"** 
+2. **Click "Run workflow"**
 3. **Configure options**:
    - `version-tag`: Specify a version tag to build (e.g., `v0.9.7`) - leave empty to use current commit
    - `publish`: Check to publish the release to PowerShell Gallery
 
 This is useful for:
+
 - Creating releases from specific commits or tags
 - Re-publishing existing versions
 - Testing release workflows before merging to main
 
 ## 🤝 Contributing
 
 We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) guide for:
+
 - How to report issues
 - Pull request process
 - Code style guidelines
@@ -385,6 +414,7 @@ We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) guid
 ## 🤖 AI Agent Support
 
 This repository includes special documentation for AI coding assistants. See [AGENTS.md](AGENTS.md) for:
+
 - Project structure and conventions
 - Function templates and patterns
 - Testing guidelines
@@ -395,7 +425,7 @@ This repository includes special documentation for AI coding assistants. See [AG
 This template uses the following PowerShell modules:
 
 | Module | Version | Purpose |
-|--------|---------|---------|
+| --------- | ---------------- | --------- |
 | **InvokeBuild** | 5.14.22 | Build orchestration |
 | **ModuleBuilder** | 3.1.8 | Module compilation |
 | **Pester** | 5.7.1 | Testing framework |
@@ -414,6 +444,7 @@ This project is licensed under the terms specified in the [LICENSE](LICENSE) fil
 ### PSScriptAnalyzer Integration
 
 Enforces PowerShell best practices and catches common mistakes:
+
 - Cmdlet design rules
 - Performance optimizations
 - Security best practices
@@ -422,6 +453,7 @@ Enforces PowerShell best practices and catches common mistakes:
 ### InjectionHunter Security
 
 Scans for common injection vulnerabilities:
+
 - Command injection risks
 - Script injection patterns
 - Unsafe variable usage
@@ -430,6 +462,7 @@ Scans for common injection vulnerabilities:
 ### ModuleBuilder
 
 Compiles your script module:
+
 - Combines all `.ps1` files into single `.psm1`
 - Updates module version automatically
 - Copies required files to output
@@ -438,6 +471,7 @@ Compiles your script module:
 ### PlatyPS Documentation
 
 Generates professional documentation:
+
 - Markdown help files for each command
 - MAML files for PowerShell's Get-Help
 - Module-level documentation
@@ -446,6 +480,7 @@ Generates professional documentation:
 ### CodeQL Semantic Analysis
 
 Advanced security scanning with GitHub CodeQL:
+
 - Runs weekly on a schedule
 - Integrates with GitHub Security tab
 - Detects complex security vulnerabilities
@@ -454,11 +489,12 @@ Advanced security scanning with GitHub CodeQL:
 ### Automated Maintenance Workflows
 
 Keep your repository clean with automated maintenance:
+
 - **Artifact Cleanup**: Automatically removes artifacts older than 2 days (configurable)
 - **Workflow Run Cleanup**: Removes old workflow runs to keep history manageable
-  - Configurable retention period (default: 2 days)
-  - Configurable minimum runs to keep (default: 2)
-  - Separate cleanup for pull requests, pushes, and scheduled runs
+- Configurable retention period (default: 2 days)
+- Configurable minimum runs to keep (default: 2)
+- Separate cleanup for pull requests, pushes, and scheduled runs
 - Runs daily at midnight via cron schedule
 - Can be triggered manually with custom parameters
 
@@ -478,4 +514,4 @@ Keep your repository clean with automated maintenance:
 
 ---
 
-**Built with ❤️ by [Warehouse Finds](https://github.com/WarehouseFinds)**
+**Built with ❤️ by [Warehouse Finds](https://github.com/WarehouseFinds)**