From eba2d2b8d033c013af4c9d1705166c7fabce165c Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:26:59 +0200 Subject: [PATCH 1/4] Standardize README landing page --- README.md | 65 ++++++++++--------------------------------------------- 1 file changed, 11 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index 1b3dc38..e615afa 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,27 @@ -# GUID +# Guid -A PowerShell module that extends the native capabilities for working with Globally Unique Identifiers (GUIDs). - -## Prerequisites - -This module uses the following external resources: -- The [PSModule framework](https://github.com/PSModule) for building, testing, and publishing the module. +Guid is a PowerShell module for working with GUID values. ## Installation -To install the module from the PowerShell Gallery, run the following commands: - -```powershell -Install-PSResource -Name GUID -Import-Module -Name GUID -``` - -## Usage - -Here are some typical use cases for the GUID module. - -### Example 1: Test if a string is a GUID - -Check if a string is a valid GUID using: +Install the module from the PowerShell Gallery: ```powershell -Test-Guid -Guid 'd85b1407-351d-4694-9392-03acc5870eb1' -'d85b1407-351d-4694-9392-03acc5870eb1' | Test-Guid -'d85b1407-351d-4694-9392-03acc5870eb1' | IsGuid +Install-PSResource -Name Guid +Import-Module -Name Guid ``` -This command returns `True` if the provided string is a valid GUID; otherwise, it returns `False`. +## Documentation -### Example 2: Find a GUID in a string +Documentation is published at [psmodule.io/Guid](https://psmodule.io/Guid/). -Extract a GUID from a string using: +Use PowerShell help and command discovery for module details: ```powershell -Search-Guid -Text "The GUID is d85b1407-351d-4694-9392-03acc5870eb1" -``` - -This command returns the GUID found in the provided string. - -### Find More Examples - -For additional usage examples, please refer to the [examples](examples) folder. You can also list all available commands with: - -```powershell -Get-Command -Module GUID -``` - -And view detailed help for each command (for instance, for New-GuidPlus) by running: - -```powershell -Get-Help -Examples +Get-Command -Module Guid +Get-Help -Examples ``` ## Contributing -Contributions are welcome—whether you're reporting an issue, suggesting improvements, or submitting new code! - -### For Users - -If you encounter any bugs, unexpected behavior, or missing functionality, please open an issue on this repository. Your feedback is valuable. - -### For Developers - -If you'd like to contribute code or enhancements, please review the [Contribution Guidelines](CONTRIBUTING.md) first. You can start by addressing -an existing issue or proposing a new feature. +Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. From 389377bdcab7e29dcef66f34d2f1dbcd6cac468e Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:41:25 +0200 Subject: [PATCH 2/4] Address Copilot README review --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e615afa..f058fc2 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ -# Guid +# GUID -Guid is a PowerShell module for working with GUID values. +GUID is a PowerShell module for working with GUID values. ## Installation Install the module from the PowerShell Gallery: ```powershell -Install-PSResource -Name Guid -Import-Module -Name Guid +Install-PSResource -Name GUID +Import-Module -Name GUID ``` ## Documentation -Documentation is published at [psmodule.io/Guid](https://psmodule.io/Guid/). +Documentation is published at [psmodule.io/GUID](https://psmodule.io/GUID/). Use PowerShell help and command discovery for module details: ```powershell -Get-Command -Module Guid -Get-Help -Examples +Get-Command -Module GUID +Get-Help Test-Guid -Examples ``` ## Contributing From 25b9be73bced72de5409754bb71dacc9855d0457 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:57:47 +0200 Subject: [PATCH 3/4] Address Copilot README review --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f058fc2..ac7f36d 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Import-Module -Name GUID ## Documentation -Documentation is published at [psmodule.io/GUID](https://psmodule.io/GUID/). +Documentation is available through PowerShell help and command discovery. You can also browse related module documentation at [psmodule.io](https://psmodule.io/). Use PowerShell help and command discovery for module details: From bbf8d0295532f082edd7501e5f31b953af28a0bb Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Jul 2026 11:37:49 +0200 Subject: [PATCH 4/4] Restore Usage showcase and drop Contributing from README --- README.md | 41 +++++++++++++++++++++++++++++++++-------- 1 file changed, 33 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ac7f36d..a2668e3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # GUID -GUID is a PowerShell module for working with GUID values. +A PowerShell module that extends the native capabilities for working with Globally Unique Identifiers (GUIDs). +It adds convenient commands to validate whether a string is a GUID and to extract GUIDs embedded in text. ## Installation @@ -11,17 +12,41 @@ Install-PSResource -Name GUID Import-Module -Name GUID ``` -## Documentation +## Usage -Documentation is available through PowerShell help and command discovery. You can also browse related module documentation at [psmodule.io](https://psmodule.io/). +### Example: Test if a string is a GUID -Use PowerShell help and command discovery for module details: +Validate whether a string is a well-formed GUID. The command accepts pipeline input and returns a boolean. ```powershell -Get-Command -Module GUID -Get-Help Test-Guid -Examples +Test-Guid -String 'd85b1407-351d-4694-9392-03acc5870eb1' +'d85b1407-351d-4694-9392-03acc5870eb1' | Test-Guid ``` -## Contributing +```text +True +True +``` + +### Example: Find a GUID in a string + +Extract the GUID embedded in a longer string. The command returns the matched GUID value. -Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. +```powershell +'The ID is d85b1407-351d-4694-9392-03acc5870eb1' | Search-Guid +``` + +```text +d85b1407-351d-4694-9392-03acc5870eb1 +``` + +## Documentation + +Documentation is published at [psmodule.io/GUID](https://psmodule.io/GUID/). + +Discover the available commands and browse their help from the terminal: + +```powershell +Get-Command -Module GUID +Get-Help -Name Test-Guid -Examples +```