Skip to content

Commit

Permalink
Minor docs fixes after adding Reqnroll support
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshKeegan committed Oct 18, 2024
1 parent 3549da7 commit 3a21f87
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@

# 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)

[![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)
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/nugetBadges.md
Original file line number Diff line number Diff line change
@@ -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")
2 changes: 1 addition & 1 deletion docs/repo/header.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 3a21f87

Please sign in to comment.