Skip to content

Commit cb7ee46

Browse files
docs: slim README.md to template purpose and onboarding pointers
Replace the filled-in module example content with a concise description of the template's purpose. The README now: - Describes what the template is and why it exists - Lists the post-creation checklist steps - Points contributors to CONTRIBUTING.md and AGENTS.md Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 9bca84d commit cb7ee46

1 file changed

Lines changed: 17 additions & 57 deletions

File tree

README.md

Lines changed: 17 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,29 @@
1-
# {{ NAME }}
1+
# Template-PSModule
22

3-
{{ DESCRIPTION }}
3+
The canonical starting template for new PowerShell modules in the PSModule organization.
44

5-
## Prerequisites
6-
7-
This uses the following external resources:
8-
- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module.
9-
10-
## Installation
11-
12-
To install the module from the PowerShell Gallery, you can use the following command:
13-
14-
```powershell
15-
Install-PSResource -Name {{ NAME }}
16-
Import-Module -Name {{ NAME }}
17-
```
18-
19-
## Usage
20-
21-
Here is a list of example that are typical use cases for the module.
22-
23-
### Example 1: Greet an entity
24-
25-
Provide examples for typical commands that a user would like to do with the module.
5+
## Purpose
266

27-
```powershell
28-
Greet-Entity -Name 'World'
29-
Hello, World!
30-
```
7+
Use this template when creating a new PowerShell module repository.
8+
It provides the CI/CD framework wiring, required community files, and starter layout that every PSModule module repository needs.
319

32-
### Example 2
10+
For step-by-step instructions, see the [template quickstart](https://psmodule.github.io/docs/Modules/Process-PSModule/template-quickstart/).
3311

34-
Provide examples for typical commands that a user would like to do with the module.
12+
## After creating a repository from this template
3513

36-
```powershell
37-
Import-Module -Name PSModuleTemplate
38-
```
14+
1. Replace the `{{ NAME }}` and `{{ DESCRIPTION }}` placeholders throughout the repository.
15+
2. Remove the scaffold example functions, tests, and examples that do not represent your module.
16+
3. Set the repository description and custom properties on GitHub.
17+
4. Confirm `.github/PSModule.yml` only overrides defaults when your module needs different behavior.
18+
5. Open a draft pull request and run the full CI pipeline.
3919

40-
### Find more examples
20+
See [repository defaults](https://psmodule.github.io/docs/Modules/Repository-Defaults/) for the full checklist.
4121

42-
To find more examples of how to use the module, please refer to the [examples](examples) folder.
43-
44-
Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module.
45-
To find examples of each of the commands you can use Get-Help -Examples 'CommandName'.
46-
47-
## Documentation
22+
## Prerequisites
4823

49-
Link to further documentation if available, or describe where in the repository users can find more detailed documentation about
50-
the module's functions and features.
24+
Modules built from this template use the [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing, and publishing.
5125

5226
## Contributing
5327

54-
Coder or not, you can contribute to the project! We welcome all contributions.
55-
56-
### For Users
57-
58-
If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
59-
product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
60-
Please see the issues tab on this project and submit a new issue that matches your needs.
61-
62-
### For Developers
63-
64-
If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information.
65-
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.
66-
67-
## Acknowledgements
68-
69-
Here is a list of people and projects that helped this project in some way.
28+
To contribute to this template itself, read the [Contribution guidelines](CONTRIBUTING.md).
29+
For agents and AI tools, start with [`AGENTS.md`](AGENTS.md).

0 commit comments

Comments
 (0)