From 5bc56a53bc0ca2ebac29770700111b4e751fef16 Mon Sep 17 00:00:00 2001 From: Ben Bodenmiller Date: Sat, 20 Feb 2021 00:08:47 -0800 Subject: [PATCH] Link to the rules from the readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 841b29150..56c04c1c1 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ Table of Contents Introduction ============ -PSScriptAnalyzer is a static code checker for PowerShell modules and scripts. PSScriptAnalyzer checks the quality of PowerShell code by running a set of rules. +PSScriptAnalyzer is a static code checker for PowerShell modules and scripts. PSScriptAnalyzer checks the quality of PowerShell code by running a [set of rules](RuleDocumentation). 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.