Updated in nuget read me file

Author: nitin27may

.github/workflows/template-publish.yml

@@ -55,6 +55,12 @@ jobs:
         run: |
           ./CreateTemplate.ps1 -SourceDirectory . -TemplateNamespace Contact -OutputDirectory ./template-output
 
+      - name: Prepare NuGet README
+        shell: pwsh
+        run: |
+          Copy-Item -Path "NuGet-README.md" -Destination "./template-output/../NuGet-README.md" -Force
+          Write-Host "NuGet README file copied to package location"
+
       - name: Create .nuspec file
         shell: pwsh
         run: |
@@ -77,7 +83,11 @@ jobs:
               <requireLicenseAcceptance>false</requireLicenseAcceptance>
               <copyright>Copyright © ${{ env.TEMPLATE_AUTHOR }} $((Get-Date).Year)</copyright>
               <summary>A full-stack template using Clean Architecture principles with .NET 9 API backend and Angular 19 frontend, containerized with Docker.</summary>
+              <readme>NuGet-README.md</readme>
             </metadata>
+            <files>
+              <file src="..\NuGet-README.md" target="\" />
+            </files>
           </package>
           "@
 
@@ -148,10 +158,34 @@ jobs:
           dotnet new --list | findstr "cleanarch-fullstack"
           
           # Create project from template
-          dotnet new cleanarch-fullstack --Organization TestCompany
+          dotnet new cleanarch-fullstack --ProjectName TestProject
           
           # List files to verify creation
           dir
+          
+          # Check for unwanted files
+          Write-Host "Checking for unwanted NuGet artifact files..."
+          $unwantedFiles = @(
+            ".signature.p7s",
+            "CleanArchitecture.FullStack.Template.nuspec",
+            "[Content_Types].xml"
+          )
+          
+          $foundUnwanted = $false
+          foreach ($file in $unwantedFiles) {
+            if (Test-Path $file) {
+              Write-Host "❌ Unwanted file found: $file" -ForegroundColor Red
+              $foundUnwanted = $true
+            } else {
+              Write-Host "✅ Unwanted file not present: $file" -ForegroundColor Green
+            }
+          }
+          
+          if ($foundUnwanted) {
+            Write-Host "Warning: Some unwanted files were found in the generated project." -ForegroundColor Yellow
+          } else {
+            Write-Host "Success: No unwanted NuGet artifact files were found." -ForegroundColor Green
+          }
 
       - name: Upload package artifact
         uses: actions/upload-artifact@v4

CreateTemplate.ps1

@@ -127,6 +127,12 @@ $templateJson = @{
     }
     sourceName = $TemplateNamespace
     preferNameDirectory = $true
+    # Set default output name to match project name
+    primaryOutputs = @(
+        @{ 
+            path = "" 
+        }
+    )
     symbols = @{
         Framework = @{
             type = "parameter"
@@ -140,13 +146,15 @@ $templateJson = @{
             )
             defaultValue = "net9.0"
         }
-        Organization = @{
+        ProjectName = @{
             type = "parameter"
             datatype = "string"
-            description = "Organization name to use in the project"
-            defaultValue = "YourCompany"
+            description = "The name of the project and solution"
+            defaultValue = "MyCleanApp"
             replaces = $TemplateNamespace
+            fileRename = $TemplateNamespace
         }
+        # Remove OutputDir parameter since the directory will match the project name
         SkipRestore = @{
             type = "parameter"
             datatype = "bool"
@@ -167,7 +175,14 @@ $templateJson = @{
                 @{
                     condition = "true"
                     include = @("**/*")
-                    exclude = @(".template.config/**/*")
+                    exclude = @(
+                        ".template.config/**/*",
+                        "*.nuspec",
+                        ".signature.p7s",
+                        "[Content_Types].xml",
+                        "_rels/**/*",
+                        "package/**/*"
+                    )
                 }
             )
         }

NuGet-README.md

@@ -0,0 +1,94 @@
+# Clean Architecture Full-Stack Template
+
+A comprehensive template for building full-stack applications using Clean Architecture principles with a .NET 9 API backend and Angular 19 frontend, containerized with Docker.
+
+## Features
+
+- **Clean Architecture**: Well-organized solution following Clean Architecture principles
+- **.NET 9 Backend**: Modern API built with the latest .NET 9 features
+- **Angular 19 Frontend**: Responsive UI built with Angular 19
+- **Docker Support**: Ready-to-use Docker configuration for development and deployment
+- **PostgreSQL**: Configured to use PostgreSQL database
+- **Modern Development Patterns**: 
+  - Generic Repositories
+  - Dependency Injection
+  - Entity Framework Core
+  - Angular Material UI components
+  - TailwindCSS for styling
+
+## Installation
+
+```bash
+dotnet new install CleanArchitecture.FullStack.Template
+```
+
+## Creating a New Project
+
+```bash
+dotnet new cleanarch-fullstack --ProjectName YourProjectName
+```
+
+### Template Parameters
+
+| Parameter | Description | Default Value | Required |
+|-----------|-------------|---------------|----------|
+| --ProjectName | Name of your project and solution | MyCleanApp | Yes |
+| --IncludeAngular | Include the Angular frontend | true | No |
+| --SkipRestore | Skip automatic package restore | false | No |
+| --Framework | Target framework | net9.0 | No |
+
+## Project Structure
+
+```
+YourProjectName/
+├── backend/
+│   ├── src/
+│   │   ├── YourProjectName.API           # API project
+│   │   ├── YourProjectName.Application   # Application layer
+│   │   ├── YourProjectName.Domain        # Domain layer
+│   │   └── YourProjectName.Infrastructure # Infrastructure layer
+│   └── tests/                            # Test projects
+├── frontend/
+│   ├── src/
+│   │   ├── app/                          # Angular application code
+│   │   ├── assets/                       # Static assets
+│   │   └── environments/                 # Environment configurations
+│   └── ...
+├── docker-compose.yml                    # Docker composition
+└── README.md                             # Project README
+```
+
+## Getting Started
+
+### Running the Backend
+
+```bash
+cd YourProjectName/backend
+dotnet restore
+dotnet build
+dotnet run --project src/YourProjectName.API
+```
+
+### Running the Frontend
+
+```bash
+cd YourProjectName/frontend
+npm install
+npm start
+```
+
+### Running with Docker
+
+```bash
+cd YourProjectName
+docker-compose up
+```
+
+## Additional Resources
+
+- [GitHub Repository](https://github.com/nitin27may/clean-architecture-docker-dotnet-angular)
+- [Clean Architecture Principles](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html)
+
+## License
+
+This template is licensed under the MIT License - see the LICENSE file for details.