Skip to content

Commit 31e7ce0

Browse files
🔧 [Docs]: Enhance "How to get started" section with detailed repository configuration steps
1 parent a83a826 commit 31e7ce0

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

‎README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ Process-PSModule follows:
1212
- [SemVer 2.0.0 specifications](https://semver.org)
1313
- [Continiuous Delivery practices](https://en.wikipedia.org/wiki/Continuous_delivery)
1414

15+
## How to get started
16+
17+
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:
20+
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. Remove the branch protection on it.
22+
2. Create a new secret in the repository called `APIKey` and set it to the API key for the PowerShell Gallery.
23+
3. Create a branch, make your changes, create a PR and let the workflow run.
24+
1525
## How it works
1626

1727
The workflow is designed to be trigger on pull requests to the repository's default branch.

0 commit comments

Comments
 (0)