Skip to content

Commit 663b119

Browse files
docs: simplify template framework guidance
1 parent 22df794 commit 663b119

1 file changed

Lines changed: 2 additions & 23 deletions

File tree

README.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,8 @@ It provides the organization framework wiring, repository contribution guidance,
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-
## Setup and getting started
13-
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.
19-
20-
1. Replace the `{{ NAME }}` placeholder with your module name throughout the repository.
21-
2. Replace the starter function, test, and example with your module's first real command.
22-
3. Set the repository description and custom properties on GitHub.
23-
4. Confirm `.github/PSModule.yml` only overrides defaults when your module needs different behavior.
24-
5. Open a draft pull request and run the full CI pipeline.
25-
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.
31-
32-
## Prerequisites
33-
34-
Modules built from this template use the [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing, and publishing.
12+
This template belongs to the Process-PSModule framework. Review the framework documentation before using
13+
or adapting the template for your organization.
3514

3615
## Contributing
3716

0 commit comments

Comments
 (0)