Update README with v3 instructions

xunit · Dec 22, 2024 · 2421b30 · 2421b30
1 parent 330849a
commit 2421b30
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,10 @@ those third parties and not by xUnit.net itself.
 
 ## How to install
 
+- xUnit.net v3: the analyzer package is referenced by the main [`xunit.v3` NuGet package](https://www.nuget.org/packages/xunit.v3) out of the box.
+If you choose to reference [`xunit.v3.core`](https://www.nuget.org/packages/xunit.v3.core) instead, you can reference
+[`xunit.analyzers`](https://www.nuget.org/packages/xunit.analyzers) explicitly.
+
 - xUnit.net v2 2.3.0 and higher: the analyzer package is referenced by the main [`xunit` NuGet package](https://www.nuget.org/packages/xunit) out of the box.
 If you choose to reference [`xunit.core`](https://www.nuget.org/packages/xunit.core) instead, you can reference
 [`xunit.analyzers`](https://www.nuget.org/packages/xunit.analyzers) explicitly.
@@ -22,9 +26,15 @@ If you choose to reference [`xunit.core`](https://www.nuget.org/packages/xunit.c
 
 ## How to uninstall
 
-If you installed xUnit.net v2 2.3.0 or higher and do not wish to use the analyzers package, replace the package reference
+- If you are using xUnit.net v3 and do not wish to use the analyzers package, replace the package reference
+to [`xunit.v3`](https://www.nuget.org/packages/xunit.v3) with the corresponding versions of [`xunit.v3.core`](https://www.nuget.org/packages/xunit.v3.core)
+and [`xunit.v3.assert`](https://www.nuget.org/packages/xunit.v3.assert).
+
+- If you are using xUnit.net v2 2.3.0 or higher and do not wish to use the analyzers package, replace the package reference
 to [`xunit`](https://www.nuget.org/packages/xunit) with the corresponding versions of [`xunit.core`](https://www.nuget.org/packages/xunit.core)
-and [`xunit.assert`](https://www.nuget.org/packages/xunit.assert)
+and [`xunit.assert`](https://www.nuget.org/packages/xunit.assert).
+
+- If you are using xUnit.net v2 v.2.0 or earlier: remove the reference to the [`xunit.analyzers` NuGet package](https://www.nuget.org/packages/xunit.analyzers).
 
 ## Analysis and Code Fix in Action
 

diff --git a/xunit.analyzers.sln b/xunit.analyzers.sln
@@ -1,4 +1,3 @@
-
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.4.33122.133
@@ -8,6 +7,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{3CAA9D63-080
 		.editorconfig = .editorconfig
 		src\Directory.Build.props = src\Directory.Build.props
 		src\Directory.Build.targets = src\Directory.Build.targets
+		README.md = README.md
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "xunit.analyzers", "src\xunit.analyzers\xunit.analyzers.csproj", "{897D042D-2C87-412F-805E-2905A1A38C83}"