From d2463d25ba743a563927440f523ac3bddb9f7939 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 01:31:52 +0200 Subject: [PATCH 1/3] Fix README placeholders --- README.md | 60 +++++++++++++++++++------------------------------------ 1 file changed, 20 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 6319793..e372709 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,49 @@ -# {{ NAME }} +# Net -{{ DESCRIPTION }} +Net is a PowerShell module for inspecting network configuration data from PowerShell. ## Prerequisites -This uses the following external resources: -- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module. +- PowerShell with `Microsoft.PowerShell.PSResourceGet` available for `Install-PSResource`. +- The [PSModule framework](https://github.com/PSModule) is used 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 }} +Install-PSResource -Name Net +Import-Module -Name Net ``` -## Usage +## Commands -Here is a list of example that are typical use cases for the module. +- `Get-NetIPConfiguration` retrieves network interface IP configuration, including addresses, prefix lengths, gateways, and DNS servers. -### Example 1: Greet an entity +## Usage -Provide examples for typical commands that a user would like to do with the module. +List IP configuration for all interfaces: ```powershell -Greet-Entity -Name 'World' -Hello, World! +Get-NetIPConfiguration ``` -### Example 2 - -Provide examples for typical commands that a user would like to do with the module. +List active IPv4 configuration only: ```powershell -Import-Module -Name PSModuleTemplate +Get-NetIPConfiguration -InterfaceStatus Up -AddressFamily IPv4 ``` -### Find more examples +The command is also available through the `IPConfig` alias: -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'. +```powershell +IPConfig -AddressFamily IPv6 +``` ## 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. +Command documentation is published at [psmodule.io/Net](https://psmodule.io/Net/). ## 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 7b9757eb092684addeb67005f401596fea353cc4 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:27:22 +0200 Subject: [PATCH 2/3] Standardize README landing page --- README.md | 34 ++++++---------------------------- 1 file changed, 6 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index e372709..169a518 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,6 @@ # Net -Net is a PowerShell module for inspecting network configuration data from PowerShell. - -## Prerequisites - -- PowerShell with `Microsoft.PowerShell.PSResourceGet` available for `Install-PSResource`. -- The [PSModule framework](https://github.com/PSModule) is used for building, testing, and publishing the module. +Net is a PowerShell module for network-related functions. ## Installation @@ -16,34 +11,17 @@ Install-PSResource -Name Net Import-Module -Name Net ``` -## Commands - -- `Get-NetIPConfiguration` retrieves network interface IP configuration, including addresses, prefix lengths, gateways, and DNS servers. - -## Usage - -List IP configuration for all interfaces: - -```powershell -Get-NetIPConfiguration -``` - -List active IPv4 configuration only: +## Documentation -```powershell -Get-NetIPConfiguration -InterfaceStatus Up -AddressFamily IPv4 -``` +Documentation is published at [psmodule.io/Net](https://psmodule.io/Net/). -The command is also available through the `IPConfig` alias: +Use PowerShell help and command discovery for module details: ```powershell -IPConfig -AddressFamily IPv6 +Get-Command -Module Net +Get-Help -Examples ``` -## Documentation - -Command documentation is published at [psmodule.io/Net](https://psmodule.io/Net/). - ## Contributing Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. From 72f7be1e1e7dca14cb05f86cd554767c7e1e23d4 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 11:02:40 +0200 Subject: [PATCH 3/3] Address Copilot README review --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 169a518..af8e2e6 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Use PowerShell help and command discovery for module details: ```powershell Get-Command -Module Net -Get-Help -Examples +Get-Help -Name 'CommandName' -Examples ``` ## Contributing