Skip to content

Commit 5c81c30

Browse files
committed
Update ReadMe a bit
1 parent 231aefa commit 5c81c30

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

ReadMe.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ A template repository to create new PowerShell modules quickly with boilerplate
44

55
## ✨ Features
66

7-
Using this template for your git repository will provide the following features out-of-the-box:
7+
Use this template for your new git repository to get the following features out-of-the-box:
88

99
- GitHub Actions workflows or Azure DevOps Pipelines YAML files that:
10-
- Publish a prerelease version on every commit to the `main` branch, and the stable version once manually approved.
10+
- Publish a prerelease version on every commit to the `main` branch, and a stable version once manually approved.
1111
- Can also manually trigger deployments of feature branches.
1212
- Version the module.
1313
- Run PSScriptAnalyzer to ensure best practices are followed.
14-
- Run tests on multiple platforms (Windows, Linux, MacOS).
14+
- Run build tests, and smoke tests on multiple platforms (Windows, Linux, MacOS).
1515
- Publish the module to the PowerShell Gallery or a custom feed.
1616
- Spell check all files in the repository.
1717
- Display test code coverage results on PRs.
@@ -24,7 +24,7 @@ Using this template for your git repository will provide the following features
2424
Use this template to create a new repository for your PowerShell module.
2525
Follow the instructions below to get started.
2626

27-
### 🗍 Create a new repo from this template
27+
### 🗍 Step 1: Create a new repo from this template
2828

2929
The official docs for creating a new repository from a template can [be found here](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
3030
In short, the steps are:
@@ -35,7 +35,7 @@ In short, the steps are:
3535
1. You should now have the new repository in your account with the name you chose.
3636
1. Clone your new repository to your local machine to start making changes to it.
3737

38-
### 🤖 Replace repo template information
38+
### 🤖 Step 2: Replace repo template information
3939

4040
Run the [_InitializeRepository.ps1](/_InitializeRepository.ps1) script to update the repository files with your module's information.
4141
You will be prompted to enter the following information:
@@ -58,7 +58,7 @@ For information that can not be updated automatically, perform the following act
5858

5959
1. Search for `UPDATE ME` in the repository and update the file accordingly.
6060

61-
### ➕ Add your module
61+
### Step 3: Add your module
6262

6363
If you already have a module written, add the module's `.psm1` and `.psd1` files to the `src` directory, replacing the existing files.
6464

@@ -70,7 +70,7 @@ If you already have a module written, add the module's `.psm1` and `.psd1` files
7070
1. Rename the `Template.PowerShell.ScriptModule.psm1` and `Template.PowerShell.ScriptModule.psd1` files in the `src` directory to match your module name.
7171
1. Perform a find-and-replace across the entire repository to replace `Template.PowerShell.ScriptModule` with your module's name (no spaces). -->
7272

73-
### 🚀 Update your CI/CD workflows
73+
### 🚀 Step 4: Update your CI/CD workflows
7474

7575
This template includes CI/CD workflows for building and publishing the PowerShell module using both GitHub Actions and Azure DevOps Pipelines.
7676
Follow the instructions for the CI/CD system you plan to use.
@@ -83,7 +83,7 @@ If using GitHub Actions for your CI/CD workflows, perform the following steps:
8383

8484
If using Azure DevOps Pipelines for your CI/CD pipelines, perform the following steps:
8585

86-
### ✔ Update boilerplate repo files
86+
### Step 5: Update boilerplate repo files
8787

8888
The following boilerplate git repository files should be reviewed and updated or removed.
8989

@@ -104,21 +104,21 @@ May require changes:
104104
- Build and deployment workflows: The workflows include extra steps that you may not want, such as spell check, code coverage, etc.
105105
Review the workflows and remove any steps that you don't want to include in your CI/CD pipeline.
106106

107-
### 📋 Create your own template (optional)
107+
### 📋 Step 6: Create your own template (optional)
108108

109109
Now that you have the repository looking the way you want, you may want to use it as a template for your future modules so that you don't have to make all of the same changes each time.
110110
In GitHub, from the repo's `Settings` tab under the `General` section, you can rename the repository to reflect that it is a template and check the box to make it a `Template repository`.
111111

112112
The caveat here is you have already ran the script that updated the repository files with your module's name and other information.
113113
In your template repo, you would want to add instructions to do a find-and-replace on the repository files to update the module's name, and any other information you want changed for new modules created from your template.
114114

115-
### ❤ Donate to support this template
115+
### Step 7: Donate to support this template (optional)
116116

117117
Buy me a hot apple cider for providing this template open source and for free 🙂
118118

119119
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5MWSTSXNYEJWW)
120120

121-
### Remove this section and everything above once setup is complete
121+
### ❌ Step 8: Remove this section and everything above once setup is complete
122122

123123
> [!IMPORTANT]
124124
> All of the information above can be deleted once you have your module setup and the CI/CD pipeline workflows are working.

0 commit comments

Comments
 (0)