From 2a4707bf82054020172911ed36ee724c43c2ee62 Mon Sep 17 00:00:00 2001 From: Robert Holt Date: Mon, 20 Apr 2020 09:02:21 -0700 Subject: [PATCH] Update UnixCompleters README --- .../README.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/Modules/Microsoft.PowerShell.UnixCompleters/README.md b/Modules/Microsoft.PowerShell.UnixCompleters/README.md index 4173f59..3e96107 100644 --- a/Modules/Microsoft.PowerShell.UnixCompleters/README.md +++ b/Modules/Microsoft.PowerShell.UnixCompleters/README.md @@ -1,4 +1,4 @@ -# PSUnixUtilCompleters +# Microsoft.PowerShell.UnixCompleters PowerShell parameter completers for native commands on Linux and macOS. @@ -17,10 +17,10 @@ To enable unix utility completions, install this module and add the following to your profile: ```powershell -Import-Module PSUnixUtilCompleters +Import-Module Microsoft.PowerShell.UnixCompleters ``` -There is also an alternate command, `Import-PSUnixUtilCompleters`, +There is also an alternate command, `Import-UnixCompleters`, that has the same functionality but is discoverable by command completion. This will register argument completers for all native commands @@ -30,7 +30,7 @@ Given the nature of native completion results, you may find this works best with PSReadLine's MenuComplete mode: ```powershell -Import-Module PSUnixUtilCompleters +Import-Module Microsoft.PowerShell.UnixCompleters Set-PSReadLineKeyHandler -Key Tab -Function MenuComplete ``` @@ -46,7 +46,7 @@ $env:COMPLETION_SHELL_PREFERENCE = 'bash' $env:COMPLETION_SHELL_PREFERENCE = '/bin/bash' -Import-Module PSUnixUtilCompleters +Import-Module Microsoft.PowerShell.UnixCompleters ``` Note that you must do this before you load the module, @@ -56,14 +56,14 @@ If you want to change the completer after loading, you can do so from PowerShell like so: ```powershell -Set-PSUnixUtilCompleter -ShellType Zsh +Set-UnixCompleter -ShellType Zsh # Or if you have a shell installed to a particular path -Set-PSUnixUtilCompleter -Shell "/bin/zsh" +Set-UnixCompleter -Shell "/bin/zsh" # You can even write your own utility completer by implementing `IUnixUtilCompleter` $myCompleter = [MyCompleter]::new() -Set-PSUnixUtilCompleter -Completer $myCompleter +Set-UnixCompleter -Completer $myCompleter ``` ## Unregistering UNIX util completions @@ -73,13 +73,13 @@ for all the commands it registered completers for when removed: ```powershell -Remove-Module PSUnixUtilCompleters +Remove-Module Microsoft.PowerShell.UnixCompleter ``` As with loading, there is also a convenience command provided for this: ```powershell -Remove-PSUnixUtilCompleters +Remove-UnixCompleters ``` ## Building the module yourself @@ -91,7 +91,7 @@ which you can invoke to build the module yourself with: ./build.ps1 -Clean ``` -This will output the built module to `out/PSUnixUtilCompleters`. +This will output the built module to `out/Microsoft.PowerShell.UnixCompleters`. ## Credits