Update documentation

denis-prodan · Sep 20, 2018 · fbcb70e · fbcb70e
1 parent 8f2f312
commit fbcb70e
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/CleanCode.NET.sln b/CleanCode.NET.sln
@@ -12,9 +12,6 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ConstructorNull", "ConstructorNull", "{05B5CB48-9A62-4DAE-B1A5-D5E52A2F171B}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Switch", "Switch", "{C431C1BA-AFB8-4B19-B285-E23F23871114}"
-	ProjectSection(SolutionItems) = preProject
-		SwitchAnalyzer\README.md = SwitchAnalyzer\README.md
-	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SwitchAnalyzer", "SwitchAnalyzer\SwitchAnalyzer\SwitchAnalyzer.csproj", "{2E929146-7F38-44E3-9FE1-16676A978ECC}"
 EndProject

diff --git a/Readme.md b/Readme.md
@@ -89,4 +89,17 @@ catch(NullReferenceException e)
 ## How to use
 There are 2 options:
 - Install nuget package to project(s) https://www.nuget.org/packages/CleanCodeNet. This is metapackage, you can install any of analyzers separately
-- Install Visual Studio extension https://marketplace.visualstudio.com/items?itemName=denis-prodan.clean-code-net
+- Install Visual Studio extension https://marketplace.visualstudio.com/items?itemName=denis-prodan.clean-code-net
+
+## How to select analyzers in Visual Studio extension
+_Tools -> Options... -> Clean Code .NET_
+
+![Options window](/Docs/CleanCodeNetOptions.png)
+
+## How to configure analyzers referenced as NuGet packages
+_Solution explorer -> {Project} -> Dependencies -> Analyzers -> Right click on analyzers -> Set Rule Set Severity_
+
+You will have new file _{ProjectName}.ruleset_ opened in editor
+![Options window](/Docs/PackageAnalyzersOptions.png)
+
+For more information about rulesets you can go to https://docs.microsoft.com/en-us/visualstudio/code-quality/use-roslyn-analyzers?view=vs-2017