From 9fa600707a97ef156c0cc2cb1e35bd2f406578f0 Mon Sep 17 00:00:00 2001
From: coffeebeats <108542400+coffeebeats@users.noreply.github.com>
Date: Wed, 1 Nov 2023 22:58:24 -0700
Subject: [PATCH] fix: update install instructions for PowerShell (#124)

* fix: correct a few errors in comments

* fix: add powershell install script to release-please update list

* fix: correct the PS install instructions
---
 .github/workflows/release-please.yml | 1 +
 README.md                            | 5 +++--
 scripts/install.ps1                  | 6 +++---
 3 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
index ccadc8c0..52c40fc9 100644
--- a/.github/workflows/release-please.yml
+++ b/.github/workflows/release-please.yml
@@ -48,6 +48,7 @@ jobs:
 
           extra-files: |
             cmd/gdenv/main.go
+            scripts/install.ps1
             scripts/install.sh
 
   publish:
diff --git a/README.md b/README.md
index 179c8efd..a2d12cbe 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@ gdenv pin -i --path /path/to/project 4.0
 
 The easiest way to install `gdenv` is by using the pre-built binaries. These can be manually downloaded and configured, but automated installation scripts are provided and recommended.
 
-See the full [installation instructions](./docs/installation.md) for additional options for installing `gdenv`.
+See the full [installation instructions](./docs/installation.md) for additional options when installing `gdenv`.
 
 > ⚠️ **WARNING:** It's good practice to inspect an installation script prior to execution. The scripts are included in this repository and can be reviewed prior to use.
 
@@ -56,7 +56,8 @@ Invoke-WebRequest `
     -UseBasicParsing `
     -Uri "https://raw.githubusercontent.com/coffeebeats/gdenv/main/scripts/install.ps1" `
     -OutFile "./install-gdenv.ps1"; `
-    &"./scripts/install-gdenv.ps1"
+    &"./install-gdenv.ps1"; `
+    Remove-Item "./install-gdenv.ps1"
 ```
 
 ## **Documentation**
diff --git a/scripts/install.ps1 b/scripts/install.ps1
index 9463304a..c401db43 100644
--- a/scripts/install.ps1
+++ b/scripts/install.ps1
@@ -22,7 +22,7 @@
   updates environment variables as needed.
 
 .PARAMETER NoModifyPath
-  Do not modify the \$PATH environment variable.
+  Do not modify the $PATH environment variable.
 
 .PARAMETER Version
   Install the specified version of 'gdenv'.
@@ -45,10 +45,10 @@
 # ------------------------------ Define: Params ------------------------------ #
 
 Param (
-  # NoModifyPath help if set, the user's $PATH variable won't be updated
+  # NoModifyPath - if set, the user's $PATH variable won't be updated
   [Switch] $NoModifyPath = $False,
 
-  # Version help override the specific version of 'gdenv' to install
+  # Version - override the specific version of 'gdenv' to install
   [String] $Version = "v0.5.2" # x-release-please-version
 )