Skip to content

Commit 7384c52

Browse files
committed
added ToC to ReadMe
1 parent a7f1b60 commit 7384c52

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

ReadMe.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
# vNugglets PowerShell Module
2+
Contents:
3+
4+
- [QuickStart](#quickStart)
5+
- [Examples](#examplesSection)
6+
- [ChangeLog](#changelog)
7+
28
This is the PowerShell module created from the nugglets from [vNugglets.com](http://vNugglets.com). This repo is meant to be a place where the vNugglets.com code can reside, separate from the blog, for easier/central consumption and collaboration.
39

410
Some of the functionality provided by the cmdlets in this module:
@@ -11,6 +17,7 @@ Some of the functionality provided by the cmdlets in this module:
1117
- Datastore evacuation, template evacuation from VMHosts
1218
- Mining virtual portgroup information (cluster-locations)
1319

20+
<a id="quickStart"></a>
1421
### QuickStart
1522
Chomping at the bit to get going with using this module? Of course you are! Go like this:
1623
- download the module, either from the latest release's .zip file on the [vNugglets.Utility Releases](https://github.com/vNugglets/vNuggletsPSMod/releases) page, or by cloning the project to some local folder with Git via:
@@ -22,6 +29,7 @@ Chomping at the bit to get going with using this module? Of course you are! Go l
2229
or, if the vNugglets.Utility module folder is not in your `Env:\PSModulePath`, specify the whole path to the module folder, like:
2330
`PS C:\> Import-Module -Name \\myserver.dom.com\PSModules\vNugglets.Utility`
2431

32+
<a id="examplesSection"></a>
2533
### Examples
2634
There are examples of some of the usages of the cmdlets in this PowerShell module at the module's GitHub Pages page [https://vNugglets.github.io/vNuggletsPSMod](https://vNugglets.github.io/vNuggletsPSMod/)
2735

@@ -30,6 +38,10 @@ The cmdlets in this module all have proper help, so you can learn and discover j
3038
- `Get-Command -Module <moduleName>`
3139
- `Get-Help -Full <cmdlet-name>`
3240

41+
<a id="changelog"></a>
42+
### ChangeLog
43+
The [ChangeLog](ChangeLog.md) for this module is, of course, a log of the major changes through the module's hitory. Enjoy the story.
44+
3345
### Other Notes
3446
A few notes on updates to this repo:
3547

0 commit comments

Comments
 (0)