Skip to content

Commit 2742b3d

Browse files
Use direct neutral prose in the installer README
1 parent cb48ff8 commit 2742b3d

1 file changed

Lines changed: 5 additions & 8 deletions

File tree

‎.github/actions/Install-PSModule/README.md‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
11
# Install-PSModule
22

3-
A GitHub Action to install and configure the PSModule helper modules for use in continuous integration and delivery (CI/CD) workflows. This action is
4-
a critical component for setting up a standardized PowerShell environment across repositories using the PSModule framework.
3+
This GitHub Action prepares the PowerShell environment for continuous integration and delivery (CI/CD) workflows.
54

6-
This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule). It is recommended to use the
7-
[Process-PSModule workflow](https://github.com/PSModule/Process-PSModule) to automate the whole process of managing the PowerShell module.
5+
The [PSModule framework](https://github.com/PSModule) includes this action.
6+
For the recommended setup, use the [Process-PSModule workflow](https://github.com/PSModule/Process-PSModule) to automate PowerShell module management.
87

98
## What this action does
109

1110
- Removes any existing instances of the `Helpers` module from the PowerShell session.
1211
- Copies the latest version of the `Helpers` module into the PowerShell module directory.
1312
- Imports the `Helpers` module, ensuring it is available for subsequent steps.
1413

15-
This action helps maintain consistency and reliability across workflows that depend on the PSModule framework.
16-
1714
## Usage
1815

1916
```yaml
@@ -31,11 +28,11 @@ _No secrets required._
3128
3229
## Outputs
3330
34-
This action does not provide any outputs.
31+
The action defines no outputs.
3532
3633
## Example
3734
38-
Here's a complete workflow example demonstrating how to use the Install-PSModule action:
35+
This example shows the action in a workflow:
3936
4037
```yaml
4138
name: CI

0 commit comments

Comments
 (0)