Merge pull request #29 from AdamWyatt34/fix-docs

fix: update documentation to replace 'PDK.CLI' with 'pdk'

Author: AdamWyatt34

README.md

@@ -35,7 +35,7 @@ A unified CLI tool for running CI/CD pipelines locally across GitHub Actions, Az
 ```bash
 dotnet build
 dotnet pack src/PDK.CLI
-dotnet tool install --global --add-source ./src/PDK.CLI/nupkg PDK.CLI
+dotnet tool install --global pdk
 ```
 
 ### Usage

docs/getting-started.md

@@ -30,7 +30,7 @@ You should see version 8.0.0 or higher.
 ### Install via dotnet tool (Recommended)
 
 ```bash
-dotnet tool install --global PDK.CLI
+dotnet tool install --global pdk
 ```
 
 ### Verify Installation

docs/guides/cicd-integration.md

@@ -35,7 +35,7 @@ jobs:
           dotnet-version: '8.0.x'
 
       - name: Install PDK
-        run: dotnet tool install --global PDK.CLI
+        run: dotnet tool install --global pdk
 
       - name: Validate Workflows
         run: |
@@ -98,7 +98,7 @@ jobs:
           dotnet-version: '8.0.x'
 
       - name: Install PDK
-        run: dotnet tool install --global PDK.CLI
+        run: dotnet tool install --global pdk
 
       - name: Check PDK Version
         run: pdk version --full
@@ -150,7 +150,7 @@ steps:
     inputs:
       version: '8.0.x'
 
-  - script: dotnet tool install --global PDK.CLI
+  - script: dotnet tool install --global pdk
     displayName: 'Install PDK'
 
   - script: pdk validate --file azure-pipelines.yml
@@ -177,7 +177,7 @@ validate-pipeline:
   image: mcr.microsoft.com/dotnet/sdk:8.0
   stage: validate
   script:
-    - dotnet tool install --global PDK.CLI
+    - dotnet tool install --global pdk
     - export PATH="$PATH:$HOME/.dotnet/tools"
     - pdk validate --file .gitlab-ci.yml
     - pdk run --dry-run --verbose
@@ -275,7 +275,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - run: dotnet tool install --global PDK.CLI
+      - run: dotnet tool install --global pdk
       - run: pdk run --dry-run --file .github/workflows/ci.yml
 ```
 
@@ -289,7 +289,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - run: dotnet tool install --global PDK.CLI
+      - run: dotnet tool install --global pdk
       - run: pdk validate --file .github/workflows/ci.yml
 
   build:
@@ -358,7 +358,7 @@ fi
 - name: Install PDK
   run: |
     if ! command -v pdk &> /dev/null; then
-      dotnet tool install --global PDK.CLI
+      dotnet tool install --global pdk
     fi
 ```
 

docs/guides/troubleshooting.md

@@ -75,10 +75,10 @@ pdk doctor
    ```
 3. Retry PDK installation:
    ```bash
-   dotnet tool install --global PDK.CLI
+   dotnet tool install --global pdk
    ```
 
-### "Package 'PDK.CLI' is not found"
+### "Package 'pdk' is not found"
 
 **Symptom:** NuGet cannot find the PDK package.
 
@@ -94,7 +94,7 @@ dotnet nuget list source
 dotnet nuget add source https://api.nuget.org/v3/index.json --name nuget.org
 
 # Retry installation
-dotnet tool install --global PDK.CLI
+dotnet tool install --global pdk
 ```
 
 ## Docker Issues

docs/installation.md

@@ -48,19 +48,19 @@ docker info
 Install PDK as a global .NET tool:
 
 ```bash
-dotnet tool install --global PDK.CLI
+dotnet tool install --global pdk
 ```
 
 **Update to the latest version:**
 
 ```bash
-dotnet tool update --global PDK.CLI
+dotnet tool update --global pdk
 ```
 
 **Uninstall:**
 
 ```bash
-dotnet tool uninstall --global PDK.CLI
+dotnet tool uninstall --global pdk
 ```
 
 ### Method 2: Local Tool
@@ -72,7 +72,7 @@ Install PDK as a local tool in your project:
 dotnet new tool-manifest
 
 # Install PDK locally
-dotnet tool install PDK.CLI
+dotnet tool install pdk
 ```
 
 Run local tools with `dotnet pdk`:
@@ -92,7 +92,7 @@ dotnet build
 dotnet pack
 
 # Install the local package
-dotnet tool install --global --add-source ./src/PDK.CLI/bin/Debug PDK.CLI
+dotnet tool install --global --add-source ./src/PDK.CLI/bin/Release pdk
 ```
 
 ## Verify Installation
@@ -238,15 +238,15 @@ dotnet tool list --global
 2. Restart your terminal
 3. Verify: `dotnet --version`
 
-### "Package 'PDK.CLI' is not found"
+### "Package 'pdk' is not found"
 
 The NuGet source may not be configured.
 
 **Solution:**
 
 ```bash
 dotnet nuget add source https://api.nuget.org/v3/index.json --name nuget.org
-dotnet tool install --global PDK.CLI
+dotnet tool install --global pdk
 ```
 
 ### Docker Permission Denied (Linux)
@@ -286,13 +286,13 @@ pdk --version
 ### Upgrade to Latest
 
 ```bash
-dotnet tool update --global PDK.CLI
+dotnet tool update --global pdk
 ```
 
 ### Upgrade to Specific Version
 
 ```bash
-dotnet tool update --global PDK.CLI --version 1.2.0
+dotnet tool update --global pdk --version 1.2.0
 ```
 
 ### Check for Updates