From 6f4909cecf83efaee8711547f736e593b9cf1322 Mon Sep 17 00:00:00 2001 From: Bernie White Date: Fri, 17 May 2019 09:18:33 +1000 Subject: [PATCH] Update install instructions (#10) --- docs/scenarios/install-instructions.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/docs/scenarios/install-instructions.md b/docs/scenarios/install-instructions.md index ac92e80..99b82a5 100644 --- a/docs/scenarios/install-instructions.md +++ b/docs/scenarios/install-instructions.md @@ -2,36 +2,40 @@ ## Prerequisites -A separate `PSRule` module is required for `PSRule.Rules.Kubernetes` to work. The required version will automatically be installed along-side `PSRule.Rules.Kubernetes` when using `Install-Module` or `Update-Module` cmdlets. - - Windows PowerShell 5.1 with .NET Framework 4.7.2+ or - PowerShell Core 6.0 or greater on Windows, macOS and Linux For a list of platforms that PowerShell Core is supported on [see](https://github.com/PowerShell/PowerShell#get-powershell). +The following modules are required for `PSRule.Rules.Kubernetes` to work: + +- PSRule + +The required version of each module will automatically be installed along-side `PSRule.Rules.Kubernetes` when using `Install-Module` or `Update-Module` cmdlets. + ## Getting the modules -Install from [PowerShell Gallery][psg] for all users (requires permissions) +Install from [PowerShell Gallery][module] for all users (requires permissions): ```powershell -# Install PSRule module -Install-Module -Name 'PSRule.Rules.Kubernetes'; +# Install module +Install-Module -Name 'PSRule.Rules.Kubernetes' -Repository PSGallery; ``` -Install from [PowerShell Gallery][psg] for current user only +Install from [PowerShell Gallery][module] for current user only: ```powershell -# Install PSRule module -Install-Module -Name 'PSRule.Rules.Kubernetes' -Scope CurrentUser; +# Install module +Install-Module -Name 'PSRule.Rules.Kubernetes' -Repository PSGallery -Scope CurrentUser; ``` -Save for offline use from PowerShell Gallery +Save for offline use from PowerShell Gallery: ```powershell -# Save PSRule module, in the .\modules directory +# Save module, in the .\modules directory Save-Module -Name 'PSRule', 'PSRule.Rules.Kubernetes' -Path '.\modules'; ``` > For pre-release versions the `-AllowPrerelease` switch must be added when calling `Install-Module` or `Save-Module`. -[psg]: https://www.powershellgallery.com/packages/PSRule.Rules.Kubernetes +[module]: https://www.powershellgallery.com/packages/PSRule.Rules.Kubernetes