diff --git a/README.md b/README.md index b6b3a4cd9..2afc6761a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Introduction +Introduction ============ PSScriptAnalyzer is a static code checker for Windows PowerShell modules and scripts. PSScriptAnalyzer checks the quality of Windows PowerShell code by running a set of rules. The rules are based on PowerShell best practices identified by PowerShell Team and the community. It generates DiagnosticResults (errors and warnings) to inform users about potential code defects and suggests possible solutions for improvements. @@ -23,12 +23,13 @@ Download the latest WMF package from [Windows Management Framework 5.0 Preview F Installation ============ -1. Build the Code using Visual Studio [solution part of the repo] and navigate to the binplace location [``~/ProjectRoot/PSScriptAnalyzer``] +1. Build the Code using Visual Studio [solution part of the repo] and navigate to the binplace location [``~/ProjectRoot/ScriptAnalyzer``] 2. In PowerShell Console: ```powershell Import-Module PSScriptAnalyzer ``` +If you have previous version of PSScriptAnalyzer installed on your machine, you may need to override old binaries by copying content of [``~/ProjectRoot/ScriptAnalyzer``] to PSModulePath. To confirm installation: run ```Get-ScriptAnalyzerRule``` in the PowerShell console to obtain the built-in rules