Skip to content

Commit 27314ed

Browse files
committed
update ReadMe with modern QuickStart, some badges
1 parent 9efc399 commit 27314ed

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

ReadMe.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# vNugglets PowerShell Module
1+
# vNugglets.Utility PowerShell Module
2+
[![PSGallery Version](https://img.shields.io/powershellgallery/v/vNugglets.VDNetworking.svg?style=flat&logo=powershell&label=PSGallery%20Version)](https://www.powershellgallery.com/packages/vNugglets.Utility) [![PSGallery Downloads](https://img.shields.io/powershellgallery/dt/vNugglets.VDNetworking.svg?style=flat&logo=powershell&label=PSGallery%20Downloads)](https://www.powershellgallery.com/packages/vNugglets.Utility)
3+
24
Contents:
35

46
- [QuickStart](#quickStart)
57
- [Examples](#examplesSection)
68
- [ChangeLog](#changelog)
79

8-
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.
10+
This is the PowerShell module created from the nugglets from [vNugglets.com](http://vNugglets.com). This repo is the place where the vNugglets.com code can reside, separate from the blog, for easier/central consumption and collaboration.
911

1012
Some of the functionality provided by the cmdlets in this module:
1113
- VIRole management (copying/duplicating)
@@ -20,21 +22,17 @@ Some of the functionality provided by the cmdlets in this module:
2022
<a id="quickStart"></a>
2123
### QuickStart
2224
Chomping at the bit to get going with using this module? Of course you are! Go like this:
23-
- 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:
24-
`PS C:\> git clone https://github.com/vNugglets/vNuggletsPSMod.git C:\temp\MyVNuggsRepoCopy`
25-
- 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:
26-
`PS C:\> Copy-Item -Recurse -Path C:\temp\MyVNuggsRepoCopy\vNugglets.Utility\ -Destination ~\Documents\WindowsPowerShell\Modules\vNugglets.Utility`
27-
- import the PowerShell module into the current PowerShell session:
28-
`PS C:\> Import-Module -Name vNugglets.Utility`
29-
or, if the vNugglets.Utility module folder is not in your `Env:\PSModulePath`, specify the whole path to the module folder, like:
30-
`PS C:\> Import-Module -Name \\myserver.dom.com\PSModules\vNugglets.Utility`
25+
Find and install the module from the PowerShell Gallery, installing for the Current User only (as specified by `-Scope`)
26+
```PowerShell
27+
Find-Module vNugglets.Utility | Install-Module -Scope CurrentUser
28+
```
3129

3230
<a id="examplesSection"></a>
3331
### Examples
3432
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/)
3533

3634
### Getting Help
37-
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:
35+
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:
3836
- `Get-Command -Module <moduleName>`
3937
- `Get-Help -Full <cmdlet-name>`
4038

@@ -43,6 +41,17 @@ The cmdlets in this module all have proper help, so you can learn and discover j
4341
The [ChangeLog](ChangeLog.md) for this module is, of course, a log of the major changes through the module's hitory. Enjoy the story.
4442

4543
### Other Notes
44+
#### Manual install if one were so inclined:
45+
- 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:
46+
`PS C:\> git clone https://github.com/vNugglets/vNuggletsPSMod.git C:\temp\MyVNuggsRepoCopy`
47+
- 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:
48+
`PS C:\> Copy-Item -Recurse -Path C:\temp\MyVNuggsRepoCopy\vNugglets.Utility\ -Destination ~\Documents\WindowsPowerShell\Modules\vNugglets.Utility`
49+
- import the PowerShell module into the current PowerShell session:
50+
`PS C:\> Import-Module -Name vNugglets.Utility`
51+
or, if the vNugglets.Utility module folder is not in your `Env:\PSModulePath`, specify the whole path to the module folder, like:
52+
`PS C:\> Import-Module -Name \\myserver.dom.com\PSModules\vNugglets.Utility`
53+
54+
4655
A few notes on updates to this repo:
4756

4857
Dec 2016

0 commit comments

Comments
 (0)