Skip to content

Commit 5a4759b

Browse files
Fix
1 parent cc39006 commit 5a4759b

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
# PSModuleTemplate
22

3-
Add a short description about the module and the project.
3+
A PowerShell module template that can be used to create new modules.
44

55
## Prerequisites
66

7-
List any prerequisites needed to use the module, such as PowerShell versions, additional modules, or permissions.
7+
This uses the following external resources:
8+
- The [PSModule framework](https://github.com/PSModule) for building, testing and publishing the module.
89

910
## Installation
1011

11-
Provide step-by-step instructions on how to install the module, including any InstallModule commands or manual installation steps.
12+
To install the module from the PowerShell Gallery, you can use the following command:
1213

1314
```powershell
14-
Install-Module -Name YourModuleName
15+
Install-PSResource -Name YourModuleName
16+
Import-Module -Name YourModuleName
1517
```
1618

1719
## Usage
1820

1921
Here is a list of example that are typical use cases for the module.
20-
This section should provide a good overview of the module's capabilities.
2122

22-
### Example 1
23+
### Example 1: Greet an entity
2324

2425
Provide examples for typical commands that a user would like to do with the module.
2526

2627
```powershell
27-
Import-Module -Name PSModuleTemplate
28+
Greet-Entity -Name 'World'
29+
Hello, World!
2830
```
2931

3032
### Example 2

0 commit comments

Comments
 (0)