Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewrdavidson authored Dec 29, 2020
1 parent 3f9e208 commit c9cd15d
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Optional items:

__Preferred Method__

From the PSGallery
From the PSGallery:

`Install-Module -Name PSQualityCheck`

Expand All @@ -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`

Expand Down

0 comments on commit c9cd15d

Please sign in to comment.