|
1 | 1 | # PSModuleTemplate |
2 | 2 |
|
3 | | -https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository |
| 3 | +<!-- |
| 4 | +Add a short description about the module and the project. |
| 5 | +--> |
4 | 6 |
|
5 | | -https://github.com/joelparkerhenderson/github-special-files-and-paths#changelog |
| 7 | +## Getting Started |
6 | 8 |
|
7 | | -https://github.com/segraef/Template |
| 9 | +### Prerequisites |
8 | 10 |
|
9 | | -https://github.com/Azure/Aks-Construction |
| 11 | +List any prerequisites needed to use the module, such as PowerShell versions, additional modules, or permissions. |
10 | 12 |
|
11 | | -https://github.com/embeddedartistry |
| 13 | +### Installation |
| 14 | + |
| 15 | +Provide step-by-step instructions on how to install the module, including any InstallModule commands or manual installation steps. |
| 16 | + |
| 17 | +```powershell |
| 18 | +Install-Module -Name YourModuleName |
| 19 | +``` |
| 20 | + |
| 21 | +### Usage |
| 22 | + |
| 23 | +Provide examples for typical commands that a user would like to do with the module. |
| 24 | + |
| 25 | +```powershell |
| 26 | +Import-Module -Name PSModuleTemplate |
| 27 | +``` |
| 28 | + |
| 29 | +## Documentation |
| 30 | + |
| 31 | +Link to further documentation if available, or describe where in the repository users can find more detailed documentation about |
| 32 | +the module's functions and features. |
| 33 | + |
| 34 | +## Contributing |
| 35 | + |
| 36 | +### For Users |
| 37 | +Encourage feedback and provide links or instructions on how users can report issues, request features, or ask questions. |
| 38 | + |
| 39 | +### For Developers |
| 40 | + |
| 41 | +Provide instructions on how to contribute to the module, including how to set up a development environment, run tests, and submit pull requests. |
| 42 | + |
| 43 | +### Contribution Guidelines |
| 44 | + |
| 45 | +If you would like to contribute, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information. |
| 46 | + |
| 47 | + |
| 48 | +## Roadmap |
| 49 | + |
| 50 | +## Acknowledgements |
| 51 | + |
| 52 | +--- |
| 53 | + |
| 54 | +- [Code of Conduct](CODE_OF_CONDUCT.md) |
| 55 | +- [Security Policy](SECURITY.md) |
| 56 | +- [Support](SUPPORT.md) |
| 57 | +- [License](LICENSE) |
0 commit comments