Skip to content

Commit aa89542

Browse files
committed
Update README.md
1 parent 3add1de commit aa89542

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,13 @@ ImageSharpCompare focus on os agnostic support and therefore depends on [SixLabo
1010

1111
## Example simple show cases
1212

13+
### Compares each RGB value of each pixel to determine the equality
14+
1315
```csharp
1416
bool isEqual = ImageSharpCompare.ImagesAreEqual("actual.png", "expected.png");
17+
```
18+
19+
### Calculates sum of diff of all pixels
1520

1621
var calcDiff = ImageSharpCompare.CalcDiff("2x2PixelBlack.png", "2x2PixelWhite.png");
1722
Console.WriteLine($"PixelErrorCount: {diff.PixelErrorCount}");
@@ -57,6 +62,7 @@ var maskedDiff = ImageSharpCompare.CalcDiff(pathPic1, pathPic2, "differenceMask.
5762
Assert.That(maskedDiff.AbsoluteError, Is.EqualTo(0));
5863
```
5964

60-
## .net Framework specific note
65+
## .net Framework specific note / ImageSharp license note
6166

62-
.net framework (an older Windows-based .NET implementation) is supported by versions 2.x.y .
67+
.net framework (an older Windows-based .NET implementation) is supported by versions 2.x.y, caused by the used dependency ImageSharp. ImageSharp dropped .net framework support starting with version 3.
68+
ImageSharp also made a license change. You may want to stick with 2.x.y if want to avoid that caused implications.

0 commit comments

Comments
 (0)