Updated readme

Author: contextduck

README.md

@@ -1,108 +1,154 @@
 # Dataverse Analyzer
 
-A Roslyn analyzer for .NET Core projects that enforces specific coding standards and best practices.
+A Roslyn analyzer enforcing coding standards for Dataverse/.NET projects.
 
-## Rule CT0001: Control Flow Braces Rule
+## Rules Overview
 
-This analyzer enforces that `if` and `else` control flow statements without braces can only contain:
-- `return` statements
-- `throw` statements  
-- `continue` statements
-- `break` statements
-- `yield break` statements
+| ID | Rule | Category | Severity |
+|----|------|----------|----------|
+| CT0001 | Braceless control flow must be return/throw/continue/break/yield break | Style | Error |
+| CT0002 | Enum properties should not be assigned literal values | Usage | Warning |
+| CT0003 | Remove empty parentheses from object initialization | Style | Error |
+| CT0004 | Remove braces from single control flow statements | Style | Error |
+| CT0005 | Constructor has duplicate DI parameter types | Usage | Warning |
+| CT0006 | Plugin class missing XML documentation | Documentation | Warning |
+| CT0007 | Use ContainsAttributes instead of Contains on Entity | Usage | Warning |
+| CT0008 | AddFilteredAttributes not allowed on Create | Usage | Error |
+| CT0009 | PreImage not allowed on Create | Usage | Error |
+| CT0010 | PostImage not allowed on Delete | Usage | Error |
 
-### Examples
+## Style Rules
+
+### CT0001: Braceless Control Flow
+
+Control flow statements without braces can only contain: `return`, `throw`, `continue`, `break`, or `yield break`.
 
-✅ **Allowed** (no braces needed):
 ```csharp
+// Allowed
 if (condition)
     return;
 
-if (error)
-    throw new Exception();
+// Not allowed - triggers CT0001
+if (condition)
+    DoSomething();
+```
+
+### CT0003: Object Initialization Parentheses
 
-while (true)
-    break;
+Remove empty parentheses when using object initializers.
 
-foreach (var item in items)
-    continue;
+```csharp
+// Allowed
+var account = new Account { Name = "Test" };
 
-if (done)
-    yield break;
+// Not allowed - triggers CT0003
+var account = new Account() { Name = "Test" };
 ```
 
-❌ **Not allowed** (braces required):
+### CT0004: Braced Control Flow
+
+Remove braces when a block contains only a single control flow statement.
+
 ```csharp
-// This will trigger CT0001
+// Allowed
 if (condition)
-    DoSomething();
+    return;
+
+// Not allowed - triggers CT0004
+if (condition)
+{
+    return;
+}
 ```
 
-## Rule CT0002: Enum Assignment Rule
+## Usage Rules
 
-This analyzer prevents assigning literal values to enum properties, requiring the use of proper enum values instead.
+### CT0002: Enum Assignment
 
-### Examples
+Enum properties should use enum values, not literals.
 
-✅ **Allowed**:
 ```csharp
+// Allowed
 AccountCategoryCode = AccountCategoryCode.Standard;
+
+// Not allowed - triggers CT0002
+AccountCategoryCode = 1;
 ```
 
-❌ **Not allowed**:
+### CT0005: Duplicate DI Parameters
+
+Constructors shouldn't have multiple parameters of the same DI type (Service, Repository, Handler, Provider, Factory, Manager, Client).
+
 ```csharp
-// This will trigger CT0002
-AccountCategoryCode = 1;
+// Not allowed - triggers CT0005
+public MyClass(IUserService userService, IUserService adminService) { }
 ```
 
-## Rule CT0003: Object Initialization Rule
+### CT0007: Entity Contains
+
+Use type-safe `ContainsAttributes` instead of string-based `Contains` on Entity types.
 
-This analyzer prevents the use of empty parentheses in object initialization when using object initializers.
+```csharp
+// Allowed
+if (account.ContainsAttributes(x => x.Name))
+
+// Not allowed - triggers CT0007
+if (account.Contains("name"))
+```
 
-### Examples
+### CT0008-CT0010: Plugin Step Configuration
+
+These rules prevent invalid plugin step configurations in Dataverse:
+
+| Rule | Restriction | Reason |
+|------|-------------|--------|
+| CT0008 | No `AddFilteredAttributes` on Create | Filtered attributes have no effect on Create |
+| CT0009 | No PreImage on Create | No previous record state exists |
+| CT0010 | No PostImage on Delete | No record state exists after deletion |
 
-✅ **Allowed**:
 ```csharp
-var account = new Account
-{
-    Name = "MoneyMan",
-};
+// Not allowed - triggers CT0008
+RegisterPluginStep<Account>(EventOperation.Create)
+    .AddFilteredAttributes(a => a.Name);
 
-var account = new Account(accountId)
-{
-    Name = "MoneyMan",
-};
+// Not allowed - triggers CT0009
+RegisterPluginStep<Account>(EventOperation.Create)
+    .AddImage(ImageType.PreImage);
+
+// Not allowed - triggers CT0010
+RegisterPluginStep<Account>(EventOperation.Delete)
+    .AddImage(ImageType.PostImage);
 ```
 
-❌ **Not allowed**:
+## Documentation Rules
+
+### CT0006: Plugin Documentation
+
+Classes implementing `IPlugin` must have XML documentation.
+
 ```csharp
-// This will trigger CT0003
-var account = new Account()
-{
-    Name = "MoneyMan",
-};
+// Allowed
+/// <summary>Updates account name on create.</summary>
+public class UpdateAccountPlugin : IPlugin { }
+
+// Not allowed - triggers CT0006
+public class UpdateAccountPlugin : IPlugin { }
 ```
 
 ## Usage
 
-The analyzer is designed to be consumed as a project reference or NuGet package in other .NET projects. When integrated, it will automatically analyze your code and report violations of the rules.
-
 ### Building
 
 ```bash
 dotnet build src\DataverseAnalyzer\DataverseAnalyzer.csproj --configuration Release
 ```
 
-The built analyzer DLL will be available in `src\DataverseAnalyzer\bin\Release\netstandard2.0\DataverseAnalyzer.dll`.
+### Integration
 
-## Integration
-
-To use this analyzer in your projects, reference the built DLL as an analyzer:
+Reference the analyzer in your project:
 
 ```xml
 <ItemGroup>
   <Analyzer Include="path\to\DataverseAnalyzer.dll" />
 </ItemGroup>
 ```
-
-The analyzer includes an automatic code fix provider that can add braces when violations are detected.