rename

jpawlowski · Aug 28, 2024 · fb39b31 · fb39b31
1 parent bdd5a15
commit fb39b31
Showing 1 changed file with 28 additions and 18 deletions.
diff --git a/src/powershell-extended/Install-NerdFont.ps1 → ...ell-extended/Invoke-NerdFontInstaller.ps1 b/src/powershell-extended/Install-NerdFont.ps1 → ...ell-extended/Invoke-NerdFontInstaller.ps1
@@ -13,8 +13,28 @@
 .REQUIREDSCRIPTS
 .EXTERNALSCRIPTDEPENDENCIES
 .RELEASENOTES
-    Version 1.0.0 (2024-08-20)
+    Version 1.0.0 (2024-08-28)
     - Initial release.
+.DESCRIPTION
+    An interactive installer for Nerd Fonts and Cascadia Code on Windows, macOS, or Linux.
+
+    You may also run this script directly from the web using the following command:
+
+    ```powershell
+    & ([scriptblock]::Create((iwr 'https://bit.ly/ps-install-nerdfont')))
+    ```
+
+    Parameters may be passed just like any other PowerShell script. For example:
+
+    ```powershell
+    & ([scriptblock]::Create((iwr 'https://bit.ly/ps-install-nerdfont'))) -Name cascadia-code, cascadia-mono
+    ```
+
+    To get a lest of available Nerd Fonts, use the following command:
+
+    ```powershell
+    & ([scriptblock]::Create((iwr 'https://bit.ly/ps-install-nerdfont'))) -List All
+    ```
 #>
 
 <#
@@ -27,6 +47,8 @@
     & ([scriptblock]::Create((iwr 'https://bit.ly/ps-install-nerdfont')))
     ```
 
+    Parameters may be passed at the end just like any other PowerShell script.
+
 .DESCRIPTION
     This PowerShell script installs Nerd Fonts on Windows, macOS, or Linux.
     Nerd Fonts is a project that patches developer targeted fonts with a high number of glyphs (icons).
@@ -38,18 +60,6 @@
     the user's font directory, or the system font directory when using the AllUsers scope on Windows
     with elevated permissions.
 
-    You may also run this script directly from the web using the following command:
-
-    ```powershell
-    & ([scriptblock]::Create((iwr 'https://bit.ly/ps-install-nerdfont')))
-    ```
-
-    Parameters may be passed just like any other PowerShell script. For example:
-
-    ```powershell
-    & ([scriptblock]::Create((iwr 'https://bit.ly/ps-install-nerdfont'))) -Name cascadia-code, cascadia-mono
-    ```
-
 .PARAMETER Name
     The name of the Nerd Font to install.
     Multiple font names can be specified as an array of strings.
@@ -107,23 +117,23 @@
     Overwrite existing font files instead of skipping them.
 
 .EXAMPLE
-    Install-NerdFont -Name cascadia-code
+    Invoke-NerdFontInstaller -Name cascadia-code
     Install the Cascadia Code fonts from the Microsoft repository.
 
 .EXAMPLE
-    Install-NerdFont -Name cascadia-mono
+    Invoke-NerdFontInstaller -Name cascadia-mono
     Install the Cascadia Mono fonts from the Microsoft repository.
 
 .EXAMPLE
-    Install-NerdFont -Name cascadia-code, cascadia-mono
+    Invoke-NerdFontInstaller -Name cascadia-code, cascadia-mono
     Install the Cascadia Code and Cascadia Mono fonts from the Microsoft repository.
 
 .EXAMPLE
-    Install-NerdFont -All -WhatIf
+    Invoke-NerdFontInstaller -All -WhatIf
     Show what would happen if all fonts were installed.
 
 .EXAMPLE
-    Install-NerdFont -List cascadia*
+    Invoke-NerdFontInstaller -List cascadia*
     List all fonts with names starting with 'cascadia'.
 
 .NOTES