From 447c03d409a68883d003f80b931359052f025e91 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 01:31:36 +0200 Subject: [PATCH 1/6] Fix README placeholders --- README.md | 58 +++++++++++++++---------------------------------------- 1 file changed, 16 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 6319793..bf7a453 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,43 @@ -# {{ NAME }} +# Dns -{{ DESCRIPTION }} +Dns is a PowerShell module for resolving host names from PowerShell scripts and automation. ## 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 Dns +Import-Module -Name Dns ``` -## Usage +## Commands -Here is a list of example that are typical use cases for the module. +- `Resolve-DnsHost` resolves a host name with `[System.Net.Dns]` and returns a structured `DnsHost` object. -### Example 1: Greet an entity +## Usage -Provide examples for typical commands that a user would like to do with the module. +Resolve a host name: ```powershell -Greet-Entity -Name 'World' -Hello, World! +Resolve-DnsHost -Name 'github.com' ``` -### Example 2 - -Provide examples for typical commands that a user would like to do with the module. +Resolve a host name for a specific address family: ```powershell -Import-Module -Name PSModuleTemplate +Resolve-DnsHost -Name 'github.com' -AddressFamily InterNetwork ``` -### 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. +Command documentation is published at [psmodule.io/Dns](https://psmodule.io/Dns/). ## 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 98eb23f0f7dcca8a4d22e614bf3ab9600ba83247 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:26:44 +0200 Subject: [PATCH 2/6] Standardize README landing page --- README.md | 28 ++++++---------------------- 1 file changed, 6 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index bf7a453..2f10238 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,6 @@ # Dns -Dns is a PowerShell module for resolving host names from PowerShell scripts and automation. - -## 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. +Dns is a PowerShell module for managing DNS tasks. ## Installation @@ -16,28 +11,17 @@ Install-PSResource -Name Dns Import-Module -Name Dns ``` -## Commands - -- `Resolve-DnsHost` resolves a host name with `[System.Net.Dns]` and returns a structured `DnsHost` object. +## Documentation -## Usage +Documentation is published at [psmodule.io/Dns](https://psmodule.io/Dns/). -Resolve a host name: +Use PowerShell help and command discovery for module details: ```powershell -Resolve-DnsHost -Name 'github.com' +Get-Command -Module Dns +Get-Help -Examples ``` -Resolve a host name for a specific address family: - -```powershell -Resolve-DnsHost -Name 'github.com' -AddressFamily InterNetwork -``` - -## Documentation - -Command documentation is published at [psmodule.io/Dns](https://psmodule.io/Dns/). - ## Contributing Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. From 84a68a7803a8b4f4f52bec5706483e0546417c28 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Jul 2026 11:18:45 +0200 Subject: [PATCH 3/6] docs: add real Usage example, fix help snippet, drop Contributing --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2f10238..a542730 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,24 @@ Install-PSResource -Name Dns Import-Module -Name Dns ``` +## Usage + +### Example: Resolve a hostname to its IP addresses + +```powershell +Resolve-DnsHost -Name 'example.com' +``` + +Returns a `DnsHost` object with the resolved host name, any aliases, and the list of IP addresses. + +### Example: Resolve only IPv4 addresses + +Use `-AddressFamily` to limit the resolution to a specific address family: + +```powershell +Resolve-DnsHost -Name 'example.com' -AddressFamily InterNetwork +``` + ## Documentation Documentation is published at [psmodule.io/Dns](https://psmodule.io/Dns/). @@ -19,9 +37,5 @@ Use PowerShell help and command discovery for module details: ```powershell Get-Command -Module Dns -Get-Help -Examples +Get-Help -Name Resolve-DnsHost -Examples ``` - -## Contributing - -Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. From 9fa6673b4e2b94d40b1f54eb4c297edaa1d98cfa Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Jul 2026 11:22:22 +0200 Subject: [PATCH 4/6] docs: clarify Resolve-DnsHost returns nothing on lookup failure --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a542730..73c4b99 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Import-Module -Name Dns Resolve-DnsHost -Name 'example.com' ``` -Returns a `DnsHost` object with the resolved host name, any aliases, and the list of IP addresses. +On a successful lookup, returns a `DnsHost` object with the resolved host name, any aliases, and the list of IP addresses. If the host cannot be resolved, nothing is returned. ### Example: Resolve only IPv4 addresses From 57f246420199b08bda610d40e877a6a051e64954 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Jul 2026 11:24:17 +0200 Subject: [PATCH 5/6] docs: describe DnsHost single Alias property accurately --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 73c4b99..62ebdbd 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Import-Module -Name Dns Resolve-DnsHost -Name 'example.com' ``` -On a successful lookup, returns a `DnsHost` object with the resolved host name, any aliases, and the list of IP addresses. If the host cannot be resolved, nothing is returned. +On a successful lookup, returns a `DnsHost` object with the resolved host name, an alias (if any), and the list of IP addresses. If the host cannot be resolved, nothing is returned. ### Example: Resolve only IPv4 addresses From 7d6dc006aed3befcb26976b5baed09d4aacd1bc2 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Jul 2026 11:37:09 +0200 Subject: [PATCH 6/6] docs: use 'hostname' to satisfy textlint terminology rule --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 62ebdbd..146bedd 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Import-Module -Name Dns Resolve-DnsHost -Name 'example.com' ``` -On a successful lookup, returns a `DnsHost` object with the resolved host name, an alias (if any), and the list of IP addresses. If the host cannot be resolved, nothing is returned. +On a successful lookup, returns a `DnsHost` object with the resolved hostname, an alias (if any), and the list of IP addresses. If the host cannot be resolved, nothing is returned. ### Example: Resolve only IPv4 addresses