Skip to content

Commit 81e1874

Browse files
docs(readme): improve formatting and clarity in setup instructions
1 parent 6e0489f commit 81e1874

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
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 Gallery and produces documentation that is published to GitHub Pages. The workflow is used by all PowerShell modules in the PSModule organization.
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.
45

56
## How to get started
67

@@ -11,11 +12,13 @@ A workflow for crafting PowerShell modules using the PSModule framework, which b
1112
<details><summary>Within the **github-pages** environment, remove the branch protection for <code>main</code>.</summary>
1213
<img src="./media/pagesEnvironment.png" alt="Remove the branch protection on main">
1314
</details>
14-
1. [Create an API key on the PowerShell Gallery](https://www.powershellgallery.com/account/apikeys). Give it permission to manage the module you are working on.
15-
1. Create a new secret in the repository called `APIKEY` and set it to the API key for the PowerShell Gallery.
16-
1. Create a branch, make your changes, create a PR and let the workflow run.
17-
1. **After merge:** The workflow automatically builds, tests, and publishes your module to the PowerShell Gallery and updates the documentation on GitHub Pages.
18-
By default the process releases a patch version, which you can change by applying labels like `minor` or `major` on the PR to bump the version accordingly.
15+
1. [Create an API key on the PowerShell Gallery](https://www.powershellgallery.com/account/apikeys). Give it permission to manage the module you
16+
are working on.
17+
2. Create a new secret in the repository (or organization) called `APIKEY` and set it to the API key for the PowerShell Gallery.
18+
2. Create a branch, make your changes, create a PR and let the workflow run.
19+
3. When merging to `main`, the workflow automatically builds, tests, and publishes your module to the PowerShell Gallery and updates the documentation
20+
on GitHub Pages. By default the process releases a patch version, which you can change by applying labels like `minor` or `major` on the PR to bump
21+
the version accordingly.
1922

2023
## How it works
2124

0 commit comments

Comments
 (0)