From e825600dba019f5029e07157d195228f7dcb1cac Mon Sep 17 00:00:00 2001 From: Ardis Lu Date: Mon, 27 May 2024 13:27:42 -0700 Subject: [PATCH] Add comment-based help docs --- install.ps1 | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/install.ps1 b/install.ps1 index 158b146..199e661 100644 --- a/install.ps1 +++ b/install.ps1 @@ -1,3 +1,36 @@ +<# +.SYNOPSIS + Install the ArdisUtilities module. + +.DESCRIPTION + By default, the ArdisUtilities module will be installed for the current session only. + If '-Persist' is specified, then the ArdisUtilities module will be installed to + the "$HOME/Documents/PowerShell/Modules" folder. + +.PARAMETER Persist + Install the ArdisUtilities module to "$HOME/Documents/PowerShell/Modules". + +.EXAMPLE + PS> ./install.ps1 + + Installs ArdisUtilities in the current session only. + +.EXAMPLE + PS> ./install.ps1 -Persist + + Installs ArdisUtilities to "$HOME/Documents/PowerShell/Modules", persisting the module across sessions. + +.EXAMPLE + PS> irm 'https://raw.githubusercontent.com/ardislu/ArdisUtilities/main/install.ps1' | iex + + Invoke this script from GitHub, installing ArdisUtilities in the current session only. + +.EXAMPLE + PS> "& { $(irm 'https://raw.githubusercontent.com/ardislu/ArdisUtilities/main/install.ps1') } -Persist" | iex + + Invoke this script from GitHub, installing ArdisUtilities to "$HOME/Documents/PowerShell/Modules" and + persisting the module across sessions. +#> [OutputType([System.Void])] [CmdletBinding()] param( -- 2.47.3