From 375ea11b8efe22ef1d8fd5f35092592061ff503b Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:26:05 +0200 Subject: [PATCH 1/2] Standardize README landing page --- README.md | 39 ++++++++++----------------------------- 1 file changed, 10 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index ba023b5..00b6260 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,27 @@ # Admin -A PowerShell module that provides a set of functions to help with checking if the current context is running in elevated mode. - -## Prerequisites - -This module requires PowerShell 5.1 or later. +Admin is a PowerShell module for working with administrator role checks. ## Installation -To install the module run the following: +Install the module from the PowerShell Gallery: ```powershell -Install-Module -Name Admin +Install-PSResource -Name Admin Import-Module -Name Admin ``` -## Usage +## Documentation + +Documentation is published at [psmodule.io/Admin](https://psmodule.io/Admin/). -### Example 1: Test if the current context is running in elevated mode +Use PowerShell help and command discovery for module details: ```powershell -Test-Admin -true +Get-Command -Module Admin +Get-Help -Examples ``` -Check if the current context is running in elevated mode. - ## 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 298dfecf050aad79e1ecc37ba827d290ed6f535e Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:27:59 +0200 Subject: [PATCH 2/2] Address Copilot README review --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 00b6260..b18a1e0 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Admin is a PowerShell module for working with administrator role checks. Install the module from the PowerShell Gallery: ```powershell -Install-PSResource -Name Admin +Install-Module -Name Admin Import-Module -Name Admin ``` @@ -19,7 +19,7 @@ Use PowerShell help and command discovery for module details: ```powershell Get-Command -Module Admin -Get-Help -Examples +Get-Help Test-Admin -Examples ``` ## Contributing