Update readme

Author: JimBobSquarePants

.github/workflows/build-and-test.yml

@@ -11,7 +11,7 @@ on:
     branches:
       - main
       - release/*
-    types: [ labeled, opened, synchronize, reopened ]
+    types: [ opened, synchronize, reopened ]
 jobs:
   # Prime a single LFS cache and expose the exact key for the matrix
   WarmLFS:

.github/workflows/code-coverage.yml

@@ -80,7 +80,8 @@ jobs:
           XUNIT_PATH: .\tests\PolygonClipper.Tests # Required for xunit
 
       - name: Codecov Update
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         if: matrix.options.codecov == true && startsWith(github.repository, 'SixLabors')
         with:
           flags: unittests
+          token: ${{ secrets.CODECOV_TOKEN }}

PolygonClipper.sln

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 18
-VisualStudioVersion = 18.2.11415.280 d18.0
+VisualStudioVersion = 18.2.11415.280
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PolygonClipper", "src\PolygonClipper\PolygonClipper.csproj", "{3C8D945E-6074-437E-B6EA-237BD0C80411}"
 EndProject
@@ -50,8 +50,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ISSUE_TEMPLATE", "ISSUE_TEM
 		.github\ISSUE_TEMPLATE\oss-bug-report.yml = .github\ISSUE_TEMPLATE\oss-bug-report.yml
 	EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Clipper2Lib", "..\..\AngusJohnson\Clipper2\CSharp\Clipper2Lib\Clipper2Lib.csproj", "{442C0648-BED0-CD51-39C6-4D54ACAEC5B3}"
-EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -74,10 +72,6 @@ Global
 		{F1965B36-D896-4BC1-8941-7FE6CEB82CD5}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{F1965B36-D896-4BC1-8941-7FE6CEB82CD5}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{F1965B36-D896-4BC1-8941-7FE6CEB82CD5}.Release|Any CPU.Build.0 = Release|Any CPU
-		{442C0648-BED0-CD51-39C6-4D54ACAEC5B3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{442C0648-BED0-CD51-39C6-4D54ACAEC5B3}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{442C0648-BED0-CD51-39C6-4D54ACAEC5B3}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{442C0648-BED0-CD51-39C6-4D54ACAEC5B3}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -91,7 +85,6 @@ Global
 		{F1965B36-D896-4BC1-8941-7FE6CEB82CD5} = {84C4B358-492B-46FC-9F11-FBB76B06BD3F}
 		{68A8CC40-6AED-4E96-B524-31B1158FDEEA} = {F0882E95-667C-48FE-B43A-24FC55D9F354}
 		{02EA681E-C7D8-13C7-8484-4AC65E1B71E8} = {6F7A3AE6-C7D1-441F-A203-BA6575931CE2}
-		{442C0648-BED0-CD51-39C6-4D54ACAEC5B3} = {F0882E95-667C-48FE-B43A-24FC55D9F354}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {2C73BEEC-091B-45E4-A0BD-7D7CD16A8451}

README.md

@@ -8,19 +8,21 @@ SixLabors.PolygonClipper
 <div align="center">
 
 [![Build Status](https://img.shields.io/github/actions/workflow/status/SixLabors/PolygonClipper/build-and-test.yml?branch=main)](https://github.com/SixLabors/PolygonClipper/actions)
-[![Code coverage](https://codecov.io/gh/SixLabors/PolygonClipper/branch/main/graph/badge.svg)](https://codecov.io/gh/SixLabors/PolygonClipper)
+[![codecov](https://codecov.io/github/SixLabors/PolygonClipper/graph/badge.svg?token=ZEK38fv18V)](https://codecov.io/github/SixLabors/PolygonClipper)
 [![License: Six Labors Split](https://img.shields.io/badge/license-Six%20Labors%20Split-%23e30183)](https://github.com/SixLabors/PolygonClipper/blob/main/LICENSE)
 
 </div>
 
-A C# implementation of the Martínez–Rueda algorithm for performing Boolean operations on polygons. This library supports union, intersection, difference, and xor operations on complex polygons with holes, multiple contours, and self-intersections.
+A C# implementation of the Martínez-Rueda algorithm for performing Boolean operations on polygons. This library supports union, intersection, difference, and xor operations on complex polygons with holes, multiple contours, and self-intersections.
 
 ## Features
 
 - Works with non-convex polygons, including holes and multiple disjoint regions
 - Handles edge cases like overlapping edges and vertical segments
 - Preserves topology: output polygons include hole/contour hierarchy
 - Deterministic and robust sweep line algorithm with O((n + k) log n) complexity
+- Includes self-intersection removal to normalize input contours for boolean operations
+- Uses double precision geometry without coordinate quantization
 
 ## Usage
 
@@ -30,13 +32,20 @@ The API centers around `Polygon` and `Contour` types. Construct input polygons u
 Polygon result = PolygonClipper.Intersect(subject, clipping);
 ```
 
+You can also normalize input before boolean operations if your contours contain self-intersections:
+
+```csharp
+Polygon clean = PolygonClipper.RemoveSelfIntersections(input);
+```
+
 ## Based On
 
 This implementation is based on the algorithm described in:
 
-> F. Martínez et al., "A simple algorithm for Boolean operations on polygons", *Advances in Engineering Software*, 64 (2013), pp. 11–19.  
+> F. Martínez et al., "A simple algorithm for Boolean operations on polygons", *Advances in Engineering Software*, 64 (2013), pp. 11-19.  
 > https://sci-hub.se/10.1016/j.advengsoft.2013.04.004
 
 ## License
 
 Six Labors Split License. See [`LICENSE`](https://github.com/SixLabors/PolygonClipper/blob/main/LICENSE) for details.
+

tests/PolygonClipper.Tests/PolygonClipper.Tests.csproj

@@ -21,11 +21,11 @@
   </Choose>
 
   <ItemGroup>
+    <PackageReference Include="Clipper2" Version="2.0.0" />
     <PackageReference Include="coverlet.collector" Version="6.0.4" />
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\..\..\AngusJohnson\Clipper2\CSharp\Clipper2Lib\Clipper2Lib.csproj" />
     <ProjectReference Include="..\..\src\PolygonClipper\PolygonClipper.csproj" />
     <ProjectReference Include="..\GeoJson\GeoJson.csproj" />
   </ItemGroup>