Skip to content

Commit dcf7a1a

Browse files
docs(readme): enhance introduction for clarity and detail on workflow functionality
1 parent 81e1874 commit dcf7a1a

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# Process-PSModule
22

3-
A workflow for crafting PowerShell modules using the PSModule framework, which builds, tests, and publishes PowerShell modules to the PowerShell
4-
Gallery and produces documentation that is published to GitHub Pages. The workflow is used by all PowerShell modules in the PSModule organization.
3+
Process-PSModule is an end-to-end GitHub Actions workflow that automates the entire lifecycle of a PowerShell module — from build and test to
4+
documentation and publication. It is part of the PSModule framework and provides a unified, standards-based process for developing PowerShell modules
5+
that adhere to consistent testing, linting, and release practices.
6+
7+
The workflow builds the PowerShell module, runs multi-platform tests, enforces code quality and coverage requirements, generates documentation, and
8+
publishes both the module to the PowerShell Gallery and its documentation site to GitHub Pages. It is the core workflow used across all PowerShell
9+
modules in the [PSModule organization](https://github.com/PSModule), ensuring reliable, automated, and maintainable delivery of PowerShell projects.
510

611
## How to get started
712

0 commit comments

Comments
 (0)