Skip to content

Commit a7f1b60

Browse files
committed
added quickstart, examples link to ReadMe
1 parent cce6ffd commit a7f1b60

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

ReadMe.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,31 @@ Some of the functionality provided by the cmdlets in this module:
1111
- Datastore evacuation, template evacuation from VMHosts
1212
- Mining virtual portgroup information (cluster-locations)
1313

14+
### QuickStart
15+
Chomping at the bit to get going with using this module? Of course you are! Go like this:
16+
- 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:
17+
`PS C:\> git clone https://github.com/vNugglets/vNuggletsPSMod.git C:\temp\MyVNuggsRepoCopy`
18+
- put the actual PowerShell module directory in some place that you like to keep your modules, say, like this, which copies the module to your personal Modules directory:
19+
`PS C:\> Copy-Item -Recurse -Path C:\temp\MyVNuggsRepoCopy\vNugglets.Utility\ -Destination ~\Documents\WindowsPowerShell\Modules\vNugglets.Utility`
20+
- import the PowerShell module into the current PowerShell session:
21+
`PS C:\> Import-Module -Name vNugglets.Utility`
22+
or, if the vNugglets.Utility module folder is not in your `Env:\PSModulePath`, specify the whole path to the module folder, like:
23+
`PS C:\> Import-Module -Name \\myserver.dom.com\PSModules\vNugglets.Utility`
1424

25+
### Examples
26+
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/)
27+
28+
### Getting Help
1529
The cmdlets in this module all have proper help, so you can learn and discover just as you would and do with any other legitimate PowerShell module:
1630
- `Get-Command -Module <moduleName>`
1731
- `Get-Help -Full <cmdlet-name>`
1832

33+
### Other Notes
1934
A few notes on updates to this repo:
2035

36+
Dec 2016
37+
- initial public release
38+
2139
Nov 2016
2240
- started whole hog on creating PowerShell module to try to contain all of this goodness
2341

0 commit comments

Comments
 (0)