Skip to content

Commit fc16870

Browse files
committed
update info about how to get module
1 parent 7fcba9c commit fc16870

File tree

2 files changed

+32
-11
lines changed

2 files changed

+32
-11
lines changed

ChangeLog.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
### ChangeLog for vNugglets.VDNetworking PowerShell module
22

3-
#### v0.5, still under development Dec 2017
3+
#### v1.0, Jan 2017
4+
- initial public "prod" release of `master` branch
5+
- published module in PowerShell Gallery
6+
7+
#### v0.5, under development in Dec 2017

ReadMe.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,32 @@ Some of the functionality provided by the cmdlets in this module:
1919
<a id="quickStart"></a>
2020
### QuickStart
2121
Chomping at the bit to get going with using this module? Of course you are! Go like this:
22-
- Eventually, we'll have this module available in the PowerShell Gallery, but for now: clone the GitHub project to some local folder with Git via:
23-
`PS C:\> git clone https://github.com/vNugglets/vNuggletsPSMod_vDNetworking.git C:\temp\MyVNuggsVDRepoCopy`
24-
- 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:
25-
`PS C:\> Copy-Item -Recurse -Path C:\temp\MyVNuggsVDRepoCopy\vNugglets.VDNetworking\ -Destination ~\Documents\WindowsPowerShell\Modules\vNugglets.VDNetworking`
26-
- import the PowerShell module into the current PowerShell session:
27-
`PS C:\> Import-Module -Name vNugglets.VDNetworking`
28-
or, if the vNugglets.VDNetworking module folder is not in your `Env:\PSModulePath`, specify the whole path to the module folder, like:
29-
`PS C:\> Import-Module -Name \\myserver.dom.com\PSModules\vNugglets.VDNetworking`
22+
- This module available in the PowerShell Gallery! To install it on your machine or to save it for inspection, first, use one of these:
23+
- Install the module:
24+
25+
`Find-Module vNugglets.VDNetworking | Install-Module`
26+
- Or, save the module first for further inspection/distribution (always a good idea):
27+
28+
`Find-Module vNugglets.VDNetworking | Save-Module -Path c:\temp\someFolder`
29+
- If you are not interested in- or able to use the PowerShell Gallery, you can get the module in this way:
30+
- clone the GitHub project to some local folder with Git via:
31+
32+
`PS C:\> git clone https://github.com/vNugglets/vNuggletsPSMod_vDNetworking.git C:\temp\MyVNuggsVDRepoCopy`
33+
- 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:
34+
35+
`PS C:\> Copy-Item -Recurse -Path C:\temp\MyVNuggsVDRepoCopy\vNugglets.VDNetworking\ -Destination ~\Documents\WindowsPowerShell\Modules\vNugglets.VDNetworking`
36+
- import the PowerShell module into the current PowerShell session:
37+
38+
`PS C:\> Import-Module -Name vNugglets.VDNetworking`
39+
- or, if the vNugglets.VDNetworking module folder is not in your `Env:\PSModulePath`, specify the whole path to the module folder when importing, like:
40+
41+
`PS C:\> Import-Module -Name \\myserver.dom.com\PSModules\vNugglets.VDNetworking`
3042

3143
<a id="examplesSection"></a>
3244
### Examples
33-
Examples are forthcoming on the web, but you can always check out the examples for each cmdlet by checking out the help for each cmdlet (see [Getting Help](#gettingHelpSection) section below)
45+
Examples are in two places:
46+
- periodically updated in the docs/ folder for the project at [docs/examples.md](docs/examples.md)
47+
- always up to date in the `Get-Help` examples for each cmdlet by checking out the help for each cmdlet (see [Getting Help](#gettingHelpSection) section below)
3448

3549
<a id="gettingHelpSection"></a>
3650
### Getting Help
@@ -40,10 +54,13 @@ The cmdlets in this module all have proper help, so you can learn and discover j
4054

4155
<a id="changelog"></a>
4256
### 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.
57+
The [ChangeLog](ChangeLog.md) for this module is, of course, a log of the major changes through the module's history. Enjoy the story.
4458

4559
### Other Notes
4660
A few notes on updates to this repo:
4761

62+
Jan 2018
63+
- initial public "prod" release
64+
4865
Dec 2017
4966
- initial public dev release

0 commit comments

Comments
 (0)