From f43404db2db8823613ee62371e73ca3ead2d54c1 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 01:31:58 +0200 Subject: [PATCH 1/2] Fix README placeholders --- README.md | 60 +++++++++++++++++++------------------------------------ 1 file changed, 21 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 28cfeb6..d74e742 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,51 @@ # Retry -A PowerShell module to create a retry mechanism around functions +Retry is a PowerShell module for running a script block with retry, catch, and finally behavior. ## Prerequisites -This uses the following external resources: -- The [PSModule framework](https://github.com/PSModule) for building, testing and publishing the module. +- PowerShell with `Microsoft.PowerShell.PSResourceGet` available for `Install-PSResource`. +- The [PSModule framework](https://github.com/PSModule) is used for building, testing, and publishing the module. ## Installation -To install the module from the PowerShell Gallery, you can use the following command: +Install the module from the PowerShell Gallery: ```powershell Install-PSResource -Name Retry Import-Module -Name Retry ``` -## Usage +## Commands -Here is a list of example that are typical use cases for the module. +- `Invoke-Retry` runs a script block until it succeeds or reaches the retry count. The command is also available through the `Retry` alias. -### Example 1: Greet an entity +## Usage -Provide examples for typical commands that a user would like to do with the module. +Retry an API call up to five times with a five-second delay: ```powershell -Greet-Entity -Name 'World' -Hello, World! +Retry -Count 5 -Delay 5 -Run { + Invoke-RestMethod -Uri 'https://api.myip.com/' +} ``` -### Example 2 - -Provide examples for typical commands that a user would like to do with the module. +Run cleanup code after the retry loop: ```powershell -Import-Module -Name PSModuleTemplate +Invoke-Retry -Count 3 -Delay 2 -Run { + Invoke-RestMethod -Uri 'https://example.invalid/status' +} -Catch { + Write-Warning 'Request failed' +} -Finally { + Write-Verbose 'Retry loop finished' +} ``` -### Find more examples - -To find more examples of how to use the module, please refer to the [examples](examples) folder. - -Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module. -To find examples of each of the commands you can use Get-Help -Examples 'CommandName'. - ## Documentation -Link to further documentation if available, or describe where in the repository users can find more detailed documentation about -the module's functions and features. +Command documentation is published at [psmodule.io/Retry](https://psmodule.io/Retry/). ## Contributing -Coder or not, you can contribute to the project! We welcome all contributions. - -### For Users - -If you don't code, you still sit on valuable information that can make this project even better. If you experience that the -product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests. -Please see the issues tab on this project and submit a new issue that matches your needs. - -### For Developers - -If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information. -You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement. - -## Acknowledgements - -Here is a list of people and projects that helped this project in some way. +Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. From 61e2405ee90987465094e78ef8591f529d74ecf0 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:27:40 +0200 Subject: [PATCH 2/2] Standardize README landing page --- README.md | 36 ++++++------------------------------ 1 file changed, 6 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index d74e742..db29284 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,6 @@ # Retry -Retry is a PowerShell module for running a script block with retry, catch, and finally behavior. - -## Prerequisites - -- PowerShell with `Microsoft.PowerShell.PSResourceGet` available for `Install-PSResource`. -- The [PSModule framework](https://github.com/PSModule) is used for building, testing, and publishing the module. +Retry is a PowerShell module for running script blocks with retry behavior. ## Installation @@ -16,36 +11,17 @@ Install-PSResource -Name Retry Import-Module -Name Retry ``` -## Commands - -- `Invoke-Retry` runs a script block until it succeeds or reaches the retry count. The command is also available through the `Retry` alias. +## Documentation -## Usage +Documentation is published at [psmodule.io/Retry](https://psmodule.io/Retry/). -Retry an API call up to five times with a five-second delay: +Use PowerShell help and command discovery for module details: ```powershell -Retry -Count 5 -Delay 5 -Run { - Invoke-RestMethod -Uri 'https://api.myip.com/' -} +Get-Command -Module Retry +Get-Help -Examples ``` -Run cleanup code after the retry loop: - -```powershell -Invoke-Retry -Count 3 -Delay 2 -Run { - Invoke-RestMethod -Uri 'https://example.invalid/status' -} -Catch { - Write-Warning 'Request failed' -} -Finally { - Write-Verbose 'Retry loop finished' -} -``` - -## Documentation - -Command documentation is published at [psmodule.io/Retry](https://psmodule.io/Retry/). - ## Contributing Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.