From 801301c7af88914271e99f0d6b26bb34727ebfa8 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:28:00 +0200 Subject: [PATCH 1/6] Standardize README landing page --- README.md | 56 +++++++------------------------------------------------ 1 file changed, 7 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 6319793..10c03c3 100644 --- a/README.md +++ b/README.md @@ -2,68 +2,26 @@ {{ DESCRIPTION }} -## Prerequisites - -This uses the following external resources: -- The [PSModule framework](https://github.com/PSModule/Process-PSModule) 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 {{ NAME }} Import-Module -Name {{ NAME }} ``` -## Usage - -Here is a list of example that are typical use cases for the module. - -### Example 1: Greet an entity - -Provide examples for typical commands that a user would like to do with the module. - -```powershell -Greet-Entity -Name 'World' -Hello, World! -``` +## Documentation -### Example 2 +Documentation is published at [psmodule.io/{{ NAME }}](https://psmodule.io/{{ NAME }}/). -Provide examples for typical commands that a user would like to do with the module. +Use PowerShell help and command discovery for module details: ```powershell -Import-Module -Name PSModuleTemplate +Get-Command -Module {{ NAME }} +Get-Help -Examples ``` -### 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. - ## 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 08936d13398464387579026c3bf2a53ccf95fb3c Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:57:47 +0200 Subject: [PATCH 2/6] Address Copilot README review --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 10c03c3..c2e6540 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Use PowerShell help and command discovery for module details: ```powershell Get-Command -Module {{ NAME }} -Get-Help -Examples +Get-Help -Name CommandName -Examples ``` ## Contributing From 5aa2c89966c2b28fec379440fa37d71fcb50414e Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 16:58:39 +0200 Subject: [PATCH 3/6] Add README capability showcase section --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index c2e6540..e8bf62e 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,15 @@ Install-PSResource -Name {{ NAME }} Import-Module -Name {{ NAME }} ``` +## Capabilities + +Use this section to show the most important things the module makes possible. Keep it short and focused on discovery. + +```powershell +# Replace this with a real example that demonstrates the module's value. +Get-Command -Module {{ NAME }} +``` + ## Documentation Documentation is published at [psmodule.io/{{ NAME }}](https://psmodule.io/{{ NAME }}/). From 162786ae14077cc2e433cc538e0d493357e171eb Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 17:16:49 +0200 Subject: [PATCH 4/6] Remove community links from README default --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index e8bf62e..239cb3e 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,3 @@ Use PowerShell help and command discovery for module details: Get-Command -Module {{ NAME }} Get-Help -Name CommandName -Examples ``` - -## Contributing - -Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. From cefbe47b6705e4b523e94eb151d7fa5deeaad61c Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 18:20:00 +0200 Subject: [PATCH 5/6] Clarify README capability showcase purpose --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 239cb3e..ba8ea35 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Import-Module -Name {{ NAME }} ## Capabilities -Use this section to show the most important things the module makes possible. Keep it short and focused on discovery. +Use this section to show the most important things the module makes possible. Keep it short: this is discovery and a first mental model, not the command reference. ```powershell # Replace this with a real example that demonstrates the module's value. From 4e64c0501cc0aef58b215519614ee6fc853cf4a3 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 18:25:40 +0200 Subject: [PATCH 6/6] Avoid templated URL in README link target --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ba8ea35..1cccc83 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Get-Command -Module {{ NAME }} ## Documentation -Documentation is published at [psmodule.io/{{ NAME }}](https://psmodule.io/{{ NAME }}/). +Documentation is published at `https://psmodule.io/{{ NAME }}/`. Use PowerShell help and command discovery for module details: