Merge pull request #523 from AlmarAubel/master

doc() Add Analyzer section to README
vkhorikov · Oct 31, 2023 · 81405ec · 81405ec
2 parents bbac5c9 + f50c76b
commit 81405ec
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -570,6 +570,16 @@ result.Should().SucceedWith(69); // throws
 result.Should().Fail(); // throws
 ```
 
+## Analyzers
+
+### [CSharpFunctionalExtensions.Analyzers](https://github.com/AlmarAubel/CSharpFunctionalExtensions.Analyzers)
+A Roslyn analyzer package that provides warnings and recommendations to prevent misuse of `Result` objects in `CSharpFunctionalExtensions`. Ensures more robust implementation when working with Result types.
+
+Available on [NuGet](https://www.nuget.org/packages/CSharpFunctionalExtensions.Analyzers)
+```bash
+dotnet add package CSharpFunctionalExtensions.Analyzers
+```
+
 ## Read or Watch more about these ideas
 
 - [Functional C#: Primitive obsession](https://enterprisecraftsmanship.com/2015/03/07/functional-c-primitive-obsession/)