From 3a21f87e3f9507fa7f480f5fc5ff444e3d44b3e5 Mon Sep 17 00:00:00 2001 From: Josh Keegan Date: Fri, 18 Oct 2024 22:01:12 +0100 Subject: [PATCH] Minor docs fixes after adding Reqnroll support --- README.md | 8 ++++---- docs/contributing.md | 4 ++-- docs/nugetBadges.md | 2 +- docs/repo/header.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3bd5cc5..eba8730 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ # xRetry -Retry flickering test cases for xUnit and SpecFlow in .NET. +Retry flickering test cases for xUnit, Reqnroll and SpecFlow in .NET. [//]: \# (Src: ciBadge.md) @@ -13,7 +13,7 @@ Retry flickering test cases for xUnit and SpecFlow in .NET. [![pipeline status](https://github.com/JoshKeegan/xRetry/actions/workflows/cicd.yaml/badge.svg)](https://github.com/JoshKeegan/xRetry/actions) [![xRetry NuGet package](https://buildstats.info/nuget/xRetry)](https://www.nuget.org/packages/xRetry "Download xRetry from NuGet") [![xRetry.SpecFlow NuGet package](https://buildstats.info/nuget/xRetry.SpecFlow)](https://www.nuget.org/packages/xRetry.SpecFlow "Download xRetry.SpecFlow from NuGet") -[![xRetry.Reqnroll NuGet package](https://buildstats.info/nuget/xRetry.Reqnroll)](https://www.nuget.org/packages/xRetry.SpecFlow "Download xRetry.Reqnroll from NuGet") +[![xRetry.Reqnroll NuGet package](https://buildstats.info/nuget/xRetry.Reqnroll)](https://www.nuget.org/packages/xRetry.Reqnroll "Download xRetry.Reqnroll from NuGet") [//]: \# (Src: whenToUse.md) @@ -216,11 +216,11 @@ opening an issue first to discuss, and make sure nobody else is working on the s #### In an IDE -To build and run locally, always build `xRetry.SpecFlowPlugin` with the Release profile before the tests to ensure MSBuild uses the latest version of your changes when building the UnitTests project. +To build and run locally, always build `xRetry.Reqnroll` and `xRetry.SpecFlow` with the Release profile before the tests to ensure MSBuild uses the latest version of your changes when building the test projects. #### From the terminal -If you install `make` and go to the `build` directory, you can run the following command to run CI locally (run lint, build, run tests and create the NuGet packages): +If you install `make` and go to the `build` directory, you can run the following command to run CI locally (run lint, build, run tests, generate docs and create the NuGet packages): ```bash make ci diff --git a/docs/contributing.md b/docs/contributing.md index 157fc7a..05a4772 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -7,11 +7,11 @@ opening an issue first to discuss, and make sure nobody else is working on the s #### In an IDE -To build and run locally, always build `xRetry.SpecFlowPlugin` with the Release profile before the tests to ensure MSBuild uses the latest version of your changes when building the UnitTests project. +To build and run locally, always build `xRetry.Reqnroll` and `xRetry.SpecFlow` with the Release profile before the tests to ensure MSBuild uses the latest version of your changes when building the test projects. #### From the terminal -If you install `make` and go to the `build` directory, you can run the following command to run CI locally (run lint, build, run tests and create the NuGet packages): +If you install `make` and go to the `build` directory, you can run the following command to run CI locally (run lint, build, run tests, generate docs and create the NuGet packages): ```bash make ci diff --git a/docs/nugetBadges.md b/docs/nugetBadges.md index 11e89e4..1921f6a 100644 --- a/docs/nugetBadges.md +++ b/docs/nugetBadges.md @@ -1,3 +1,3 @@ [![xRetry NuGet package](https://buildstats.info/nuget/xRetry)](https://www.nuget.org/packages/xRetry "Download xRetry from NuGet") [![xRetry.SpecFlow NuGet package](https://buildstats.info/nuget/xRetry.SpecFlow)](https://www.nuget.org/packages/xRetry.SpecFlow "Download xRetry.SpecFlow from NuGet") -[![xRetry.Reqnroll NuGet package](https://buildstats.info/nuget/xRetry.Reqnroll)](https://www.nuget.org/packages/xRetry.SpecFlow "Download xRetry.Reqnroll from NuGet") +[![xRetry.Reqnroll NuGet package](https://buildstats.info/nuget/xRetry.Reqnroll)](https://www.nuget.org/packages/xRetry.Reqnroll "Download xRetry.Reqnroll from NuGet") diff --git a/docs/repo/header.md b/docs/repo/header.md index e39ad29..846331f 100644 --- a/docs/repo/header.md +++ b/docs/repo/header.md @@ -1,3 +1,3 @@ # xRetry -Retry flickering test cases for xUnit and SpecFlow in .NET. +Retry flickering test cases for xUnit, Reqnroll and SpecFlow in .NET.