PSModuleTemplate¶
A PowerShell module template that can be used to create new modules.
Prerequisites¶
This uses the following external resources: - The PSModule framework for building, testing and publishing the module.
Installation¶
To install the module from the PowerShell Gallery, you can use the following command:
Install-PSResource -Name YourModuleName
Import-Module -Name YourModuleName
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.
Greet-Entity -Name 'World'
Hello, World!
Example 2¶
Provide examples for typical commands that a user would like to do with the module.
Import-Module -Name PSModuleTemplate
Find more examples¶
To find more examples of how to use the module, please refer to the 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 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.