Skip to content

Commit 22df794

Browse files
docs: distinguish Process-PSModule audiences
1 parent 971b8ed commit 22df794

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,30 @@ The canonical starting template for new PowerShell modules in the PSModule organ
44

55
## Purpose
66

7-
Use this template when creating a new PowerShell module repository.
8-
It provides the CI/CD framework wiring, repository contribution guidance, and starter layout that every PSModule module repository needs.
7+
Use this template when creating a new PowerShell module repository in the PSModule organization.
8+
It provides the organization framework wiring, repository contribution guidance, and starter layout.
99
Code of Conduct, security, and support policies are inherited from [`PSModule/.github`](https://github.com/PSModule/.github).
1010
Process-PSModule owns release generation, so the template does not include GitHub generated-release-notes configuration.
1111

12-
For step-by-step instructions, see the [template quickstart](https://github.com/PSModule/Process-PSModule).
12+
## Setup and getting started
1313

14-
## After creating a repository from this template
14+
For setup and getting-started information, see the [Process-PSModule documentation](https://psmodule.io/Process-PSModule/).
15+
16+
### PSModule organization
17+
18+
Use this template to create a module repository within the PSModule organization.
1519

1620
1. Replace the `{{ NAME }}` placeholder with your module name throughout the repository.
1721
2. Replace the starter function, test, and example with your module's first real command.
1822
3. Set the repository description and custom properties on GitHub.
1923
4. Confirm `.github/PSModule.yml` only overrides defaults when your module needs different behavior.
2024
5. Open a draft pull request and run the full CI pipeline.
2125

22-
See [repository defaults](https://github.com/PSModule/Process-PSModule) for the full checklist.
26+
### Other organizations
27+
28+
Process-PSModule can also be used outside the PSModule organization. Configure its reusable workflow,
29+
repository settings, credentials, documentation site, and release process for your own organization.
30+
Start with the Process-PSModule documentation rather than assuming this template's organization defaults apply.
2331

2432
## Prerequisites
2533

0 commit comments

Comments
 (0)