From c9cd15d3c8c7e13c6480f345eb0f4adc37d58356 Mon Sep 17 00:00:00 2001 From: Andrew Davidson Date: Tue, 29 Dec 2020 16:08:37 +0000 Subject: [PATCH] Update README.md --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4e201d7..45fa068 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Optional items: __Preferred Method__ -From the PSGallery +From the PSGallery: `Install-Module -Name PSQualityCheck` @@ -46,29 +46,27 @@ __For PowerShell 7.x__ ## Usage -Basic usage: - -Check the folder C:\Scripts and all subfolders beneath it: +#### Check the folder C:\Scripts and all subfolders beneath it: `Invoke-PSQualityCheck -Path 'C:\Scripts'` -Check the folders C:\Scripts and C:\MoreScripts' and all subfolders beneath both folders +#### Check the folders C:\Scripts and C:\MoreScripts' and all subfolders beneath both folders `Invoke-PSQualityCheck -Path @('C:\Scripts', 'C:\MoreScripts')` -Check the file C:\Scripts\Script.ps1: +#### Check the file C:\Scripts\Script.ps1: `Invoke-PSQualityCheck -File 'C:\Scripts\Script.ps1'` -Check the files C:\Scripts\Script1.ps1, C:\Scripts\Script2.ps1: +#### Check the files C:\Scripts\Script1.ps1, C:\Scripts\Script2.ps1: `Invoke-PSQualityCheck -File @('C:\Scripts\Script.ps1', 'C:\Scripts\Script.ps1')` -Check the file C:\Scripts\Script.ps1 including the extra PSScriptAnalyzer rules used by SonarQube: +#### Check the file C:\Scripts\Script.ps1 including the extra PSScriptAnalyzer rules used by SonarQube: `Invoke-PSQualityCheck -File 'C:\Scripts\Script.ps1' -SonarQubeRulesPath 'C:\SonarQubeRules'` -This will display a summary of the checks performed (example below uses sample data): +#### Check the folder C:\Scripts and all subfolders beneath it and display a summary of the checks performed (example below uses sample data): `Invoke-PSQualityCheck -Path 'C:\Scripts' -ShowCheckResults`