diff --git a/README.md b/README.md index 6319793..146bedd 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,41 @@ -# {{ NAME }} +# Dns -{{ DESCRIPTION }} - -## Prerequisites - -This uses the following external resources: -- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module. +Dns is a PowerShell module for managing DNS tasks. ## 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 -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. +### Example: Resolve a hostname to its IP addresses ```powershell -Greet-Entity -Name 'World' -Hello, World! +Resolve-DnsHost -Name 'example.com' ``` -### Example 2 +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. -Provide examples for typical commands that a user would like to do with the module. +### Example: Resolve only IPv4 addresses + +Use `-AddressFamily` to limit the resolution to a specific address family: ```powershell -Import-Module -Name PSModuleTemplate +Resolve-DnsHost -Name 'example.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. +Documentation is published at [psmodule.io/Dns](https://psmodule.io/Dns/). -## Contributing +Use PowerShell help and command discovery for module details: -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. +```powershell +Get-Command -Module Dns +Get-Help -Name Resolve-DnsHost -Examples +```