Skip to content

Commit

Permalink
Update readme (#4)
Browse files Browse the repository at this point in the history
* Update README

* update build script for release version detection
  • Loading branch information
wethreetrees authored Aug 11, 2021
1 parent ad813d3 commit 3d42001
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 17 deletions.
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,14 @@ Functions to enable advanced PSObject analysis and comparison.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

Pester is required for running the test suite.

```powershell
Install-Module Pester -MinimumVersion 5.0.0 -Repository PSGallery
```

### Installing

This module can be installed from the (nuget.deloitteresources.com) repository. Repository setup instructions can be found on that site.

Install the latest stable release

```ps
Install-Module -Name PSObjectTools -Repository GTIPackageRepository
```

Install the latest development release

```ps
Install-Module -Name PSObjectTools -Repository GTIPackageRepository -AllowPrerelease
Install-Module -Name PSObjectTools -Repository PSGallery
```

### Basic Usage
Expand Down Expand Up @@ -124,4 +110,4 @@ All versioning is handled in the [build script](module.build.ps1).

## Acknowledgments


Inspired by Phil Factor's work, as seen here: https://www.red-gate.com/simple-talk/blogs/display-object-a-powershell-utility-cmdlet/
3 changes: 2 additions & 1 deletion build_tools/module.build.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Enter-Build {
$module = Find-Module -Name $Name -Repository PSGallery -ErrorAction SilentlyContinue
if ($module) {
$module | Save-Module -Path $Path -Force
$module
}
} catch {
$PSCmdlet.ThrowTerminatingError($_)
Expand Down Expand Up @@ -192,7 +193,7 @@ function GetPublicFunctionInterfaces {$function:GetPublicFunctionInterfaces}
$ScriptBlock = {
$releasedModule = Import-Module -Name "$Using:ReleasedModulePath\$Using:ModuleName" -PassThru -Force -ErrorAction Stop

$releasedModuleManifestPath = "$Using:ReleasedModulePath\$Using:ModuleName\$Using:ModuleName.psd1"
$releasedModuleManifestPath = "$Using:ReleasedModulePath\$Using:ModuleName\*\$Using:ModuleName.psd1"
$prereleaseValue = Get-ManifestValue -Path $releasedModuleManifestPath -PropertyName Prerelease
$functionList = $releasedModule.ExportedFunctions.Values

Expand Down

0 comments on commit 3d42001

Please sign in to comment.