https://github.com/PSModule/Template-PSModule

Template for a PowerShell module repo.
https://github.com/PSModule/Template-PSModule

powershell

Last synced: 22 days ago
JSON representation

Template for a PowerShell module repo.

• Host: GitHub
• URL: https://github.com/PSModule/Template-PSModule
• Owner: PSModule
• License: mit
• Created: 2021-12-25T15:28:43.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-04T23:53:09.000Z (4 months ago)
• Last Synced: 2024-07-27T13:10:27.376Z (4 months ago)
• Topics: powershell
• Language: PowerShell
• Homepage:
• Size: 120 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• jimsghstars - PSModule/Template-PSModule - Template for a PowerShell module repo. (PowerShell)

README

        
# {{ NAME }}

{{ DESCRIPTION }}

## Prerequisites

This uses the following external resources:

- The [PSModule framework](https://github.com/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.

## 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.