From 7f7bbc3cf6614e9b05acb59866d538b788bc1dae Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 01:31:46 +0200 Subject: [PATCH 1/7] Fix README placeholders --- README.md | 68 ++++--------------------------------------------------- 1 file changed, 5 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index 6319793..08a6f42 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,11 @@ -# {{ NAME }} +# IPv6 -{{ DESCRIPTION }} +IPv6 is intended to be a PowerShell module for managing IPv6 networking. -## Prerequisites +## Status -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: - -```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! -``` - -### Example 2 - -Provide examples for typical commands that a user would like to do with the module. - -```powershell -Import-Module -Name PSModuleTemplate -``` - -### 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. +This repository is currently a placeholder. The module source still contains scaffold code, so there are no supported commands or usage examples to document yet. ## 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 when implementation work begins. From 6d3e706a61732e4403193b079597cda22ccbea8e Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:27:08 +0200 Subject: [PATCH 2/7] Standardize README landing page --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 08a6f42..cd66781 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ IPv6 is intended to be a PowerShell module for managing IPv6 networking. This repository is currently a placeholder. The module source still contains scaffold code, so there are no supported commands or usage examples to document yet. +## Documentation + +When this module is implemented, command details should live in PowerShell help and generated documentation rather than being duplicated in this README. + ## Contributing Issues and pull requests are welcome when implementation work begins. From 8da05f6a43813ff2239a2dd98a5f700796ba6f83 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:41:32 +0200 Subject: [PATCH 3/7] Address Copilot README review --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cd66781..706db41 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ IPv6 is intended to be a PowerShell module for managing IPv6 networking. ## Status -This repository is currently a placeholder. The module source still contains scaffold code, so there are no supported commands or usage examples to document yet. +This repository is currently a placeholder. The module source still contains template scaffold commands used by tests, but no supported IPv6-focused commands or usage examples are available yet. ## Documentation From b6bc56861b870e20a91572268a7329e976a0d453 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:44:11 +0200 Subject: [PATCH 4/7] Address Copilot README review --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 706db41..392b543 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ IPv6 is intended to be a PowerShell module for managing IPv6 networking. ## Status -This repository is currently a placeholder. The module source still contains template scaffold commands used by tests, but no supported IPv6-focused commands or usage examples are available yet. +This repository is currently a placeholder. The module source still contains template scaffold commands used by tests, but no supported IPv6-focused commands or usage examples are available yet. The module is not ready for general installation; contributors can run the repository tests locally with Pester while implementation work is pending. ## Documentation @@ -12,4 +12,4 @@ When this module is implemented, command details should live in PowerShell help ## Contributing -Issues and pull requests are welcome when implementation work begins. +Design discussion issues are welcome now. Please wait to open implementation pull requests until module development begins. From b3f51ecd586efc872a3585b695027a7a0f59f8fd Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:45:41 +0200 Subject: [PATCH 5/7] Address Copilot README review --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 392b543..9036333 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ IPv6 is intended to be a PowerShell module for managing IPv6 networking. ## Status -This repository is currently a placeholder. The module source still contains template scaffold commands used by tests, but no supported IPv6-focused commands or usage examples are available yet. The module is not ready for general installation; contributors can run the repository tests locally with Pester while implementation work is pending. +This repository is currently a placeholder. The module source currently contains only template scaffold commands used by tests, and those commands are not IPv6-focused public API. No supported IPv6-focused commands or usage examples are available yet. The module is not ready for general installation; contributors can run the repository tests locally with Pester while implementation work is pending. ## Documentation From e00561817b1397eef0d8c9ea863c56b63fecd3cb Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:49:33 +0200 Subject: [PATCH 6/7] Address Copilot README review --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9036333..8e7ae82 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ IPv6 is intended to be a PowerShell module for managing IPv6 networking. ## Status -This repository is currently a placeholder. The module source currently contains only template scaffold commands used by tests, and those commands are not IPv6-focused public API. No supported IPv6-focused commands or usage examples are available yet. The module is not ready for general installation; contributors can run the repository tests locally with Pester while implementation work is pending. +This repository is currently a placeholder. The module source currently contains only template scaffold commands used by tests, and those commands are not IPv6-focused public API. + +No supported IPv6-focused commands or usage examples are available yet. The module is not ready for general installation; contributors can run the repository tests locally with Pester while implementation work is pending. ## Documentation From d2240586c2a522c872ca9d6a6fcec886f3bb933e Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:57:50 +0200 Subject: [PATCH 7/7] Address Copilot README review --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e7ae82..5df3fb1 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,11 @@ IPv6 is intended to be a PowerShell module for managing IPv6 networking. This repository is currently a placeholder. The module source currently contains only template scaffold commands used by tests, and those commands are not IPv6-focused public API. -No supported IPv6-focused commands or usage examples are available yet. The module is not ready for general installation; contributors can run the repository tests locally with Pester while implementation work is pending. +No supported IPv6-focused commands or usage examples are available yet. The module is not ready for general installation; contributors can run the repository tests locally with Pester while implementation work is pending: + +```powershell +Invoke-Pester +``` ## Documentation