Skip to content

Commit 9df1793

Browse files
Refactor code structure for improved readability and maintainability
1 parent a5e468a commit 9df1793

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,17 @@ Process-PSModule follows:
1515
## How to get started
1616

1717
1. [Create a repository from the Template-Module](https://github.com/PSModule/Template-PSModule).
18-
This will create a new repository with the same structure as the PSModule organization.
19-
2. Configure the repository:
18+
1. Configure the repository:
2019
1. Enable GitHub Pages in the repository settings. Set it to deploy from `GitHub Actions`.
21-
This will create an environment called `github-pages` that is used to deploy the documentation to GitHub Pages.
20+
1. This will create an environment called `github-pages` that GitHub deploys your site to.
2221
Within the environment, remove the branch protection for `main`.
23-
2. [Create an API key on the PowerShell Gallery](https://www.powershellgallery.com/account/apikeys). Give it enough permission to manage the module you are working on.
24-
3. Create a new secret in the repository called `APIKEY` and set it to the API key for the PowerShell Gallery.
25-
3. Create a branch, make your changes, create a PR and let the workflow run.
22+
<details>
23+
<summary>Remove the branch protection for `main`</summary>
24+
![Remove the branch protection on main](./media/pagesEnvironment.png)
25+
</details>
26+
1. [Create an API key on the PowerShell Gallery](https://www.powershellgallery.com/account/apikeys). Give it enough permission to manage the module you are working on.
27+
1. Create a new secret in the repository called `APIKEY` and set it to the API key for the PowerShell Gallery.
28+
1. Create a branch, make your changes, create a PR and let the workflow run.
2629

2730
## How it works
2831

media/pagesEnvironment.png

26.7 KB
Loading

0 commit comments

Comments
 (0)