Skip to content

Commit 1a091a3

Browse files
committed
Documentation update
1 parent a079b63 commit 1a091a3

1 file changed

Lines changed: 16 additions & 13 deletions

File tree

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,31 @@ This patching feature is specially useful when updating Entity Framework entitie
1212

1313
## Installation
1414

15-
Using NuGet package manager console:
15+
Using .NET CLI:
1616

1717
```
18-
Install-Package ObjDiff
18+
dotnet add package ObjDiff
1919
```
2020

21-
Using .NET CLI:
21+
Using NuGet package manager console:
2222

2323
```
24-
dotnet add package ObjDiff
24+
Install-Package ObjDiff
2525
```
2626

27-
## Features
2827

29-
* Compares arrays and collections
30-
* Compares children objects
31-
* Configuration options to ignore specific elements
32-
* Patch an object with an obtained set of differences
3328

34-
## Current Limitations
29+
## Features
30+
31+
* Compares arrays and collections.
32+
* Compares children objects.
33+
* Configuration options to ignore specific elements.
34+
* Patch an object with an obtained set of differences.
3535

36-
* Only allows to compare objects of the same type
37-
* Only public properties are compared
36+
## Limitations
3837

39-
The above limitations may be addressed in future versions.
38+
* Only allows to compare objects of the same type.
39+
* Only public properties are compared.
4040

4141
## Usage
4242

@@ -95,6 +95,9 @@ public class CompareOptions
9595
/// Ignore properties named with any of the specified values. None set by default.
9696
public string[] IgnoredProperties { get; set; }
9797

98+
/// Don't dive into any property named with any of the specified values. None set by default.
99+
public string[] DontDiveProperties { get; set; }
100+
98101
/// Maximum number of children levels to dive into. Default value is 10.
99102
public uint MaxDepth { get; set; }
100103
}

0 commit comments

Comments
 (0)