Skip to content

Commit 736dc8a

Browse files
committed
Updated ReadMe with corrected paths and added icon
Corrected the example paths. Added the icon the the ReadMe
1 parent 7573edb commit 736dc8a

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<img src="icon.svg" alt="NewModuleTemplate Icon" width="160" align="right">
2+
13
# NewModuleTemplate
24

35
[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/NewModuleTemplate.svg?style=flat-square)](https://www.powershellgallery.com/packages/NewModuleTemplate)
@@ -40,13 +42,13 @@ These tools are not required for the module to function, and are not included wh
4042

4143
This module includes PlatyPS‑generated Markdown help (full mode only).
4244

43-
- Docs folder: `Docs/`
44-
- Update script: `Scripts/Update-ModuleDocumentation.ps1`
45+
- Docs folder: `Docs\`
46+
- Update script: `Scripts\Update-ModuleDocumentation.ps1`
4547

4648
Regenerate docs:
4749

4850
```powershell
49-
pwsh Scripts/Update-ModuleDocumentation.ps1
51+
pwsh Scripts\Update-ModuleDocumentation.ps1
5052
```
5153

5254
---
@@ -76,7 +78,7 @@ Once installed and imported, you can generate a new PowerShell module scaffold u
7678
Creates a complete, production‑ready module structure:
7779

7880
```powershell
79-
New-ModuleTemplate -Path "C:\\Projects" -Name "MyModule"
81+
New-ModuleTemplate -Path "C:\Projects" -Name "MyModule"
8082
```
8183

8284
This generates:
@@ -94,7 +96,7 @@ This generates:
9496
Creates only the essential module components:
9597

9698
```powershell
97-
New-ModuleTemplate -Path "C:\\Projects" -Name "MyModule" -Minimal
99+
New-ModuleTemplate -Path "C:\Projects" -Name "MyModule" -Minimal
98100
```
99101

100102
Minimal mode includes:
@@ -112,7 +114,7 @@ No Git, no tests, no docs, no analyzer, no scripts.
112114
If the module folder already exists, you can refresh the scaffolding files:
113115

114116
```powershell
115-
New-ModuleTemplate -Path "C:\\Projects" -Name "MyModule" -Force
117+
New-ModuleTemplate -Path "C:\Projects" -Name "MyModule" -Force
116118
```
117119

118120
`-Force` overwrites only the files generated by the scaffolder. It does **not** delete your module or remove custom code.
@@ -122,15 +124,15 @@ New-ModuleTemplate -Path "C:\\Projects" -Name "MyModule" -Force
122124
You can selectively disable parts of the full scaffold:
123125

124126
```powershell
125-
New-ModuleTemplate -Path "C:\\Projects" -Name "MyModule" -NoTests -NoDocs -NoAnalyzer -NoScripts
127+
New-ModuleTemplate -Path "C:\Projects" -Name "MyModule" -NoTests -NoDocs -NoAnalyzer -NoScripts
126128
```
127129

128130
### **Disabling Git Initialization**
129131

130132
Git is enabled by default in full mode. To disable it:
131133

132134
```powershell
133-
New-ModuleTemplate -Path "C:\\Projects" -Name "MyModule" -NoGit
135+
New-ModuleTemplate -Path "C:\Projects" -Name "MyModule" -NoGit
134136
```
135137

136138
Git is always disabled in minimal mode.
@@ -188,15 +190,15 @@ Invoke-Pester -Path Tests
188190
## 🔧 Build Script (full mode)
189191

190192
```powershell
191-
pwsh Scripts/build.ps1
193+
pwsh Scripts\build.ps1
192194
```
193195

194196
---
195197

196198
## 📤 Publish Script (full mode)
197199

198200
```powershell
199-
pwsh Scripts/publish.ps1 -ApiKey '<Your PSGallery API Key>'
201+
pwsh Scripts\publish.ps1 -ApiKey '<Your PSGallery API Key>'
200202
```
201203

202204
---

0 commit comments

Comments
 (0)