Skip to content

📖 [Docs]: README pages now use the standard module landing-page format #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
base: main
Choose a base branch
from
Open

📖 [Docs]: README pages now use the standard module landing-page format #16

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eba2d2b
Standardize README landing page
MariusStorhaug Jul 6, 2026
389377b
Address Copilot README review
MariusStorhaug Jul 6, 2026
25b9be7
Address Copilot README review
MariusStorhaug Jul 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 7 additions & 50 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,70 +1,27 @@
# 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:
Install the module from the PowerShell Gallery:

```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:

```powershell
Test-Guid -Guid 'd85b1407-351d-4694-9392-03acc5870eb1'
'd85b1407-351d-4694-9392-03acc5870eb1' | Test-Guid
'd85b1407-351d-4694-9392-03acc5870eb1' | IsGuid
```

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 available through PowerShell help and command discovery. You can also browse related module documentation at [psmodule.io](https://psmodule.io/).

Extract a GUID from a string using:

```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:
Use PowerShell help and command discovery for module details:

```powershell
Get-Command -Module GUID
```

And view detailed help for each command (for instance, for New-GuidPlus) by running:

```powershell
Get-Help -Examples <command>
Get-Help Test-Guid -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.
Loading