From f50c76be80c8e79b64be3053f4c86ab7c9fdf876 Mon Sep 17 00:00:00 2001
From: almaraubel <almar@aubel.nl>
Date: Mon, 30 Oct 2023 08:33:06 +0100
Subject: [PATCH] doc() Add Analyzer section to README

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 653ce308..c4836373 100644
--- 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/)