From f72cefa52c78d43d8d08c55910cf3a5d7bd44fdb Mon Sep 17 00:00:00 2001 From: Florian Carrier Date: Mon, 7 Oct 2024 10:54:27 +0200 Subject: [PATCH] Update documentation --- CHANGELOG.md | 23 +++++++-- PSTK.psd1 | 2 +- README.md | 129 ++++++++++++++++++++++++++------------------------- 3 files changed, 88 insertions(+), 66 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 659f92c..8e94509 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,14 +5,31 @@ All notable changes to the [PSTK](https://github.com/Akaizoku/PSTK) project will The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [1.2.6](https://github.com/Akaizoku/PSTK/compare/1.2.5...develop) - Unreleased +## [1.2.6](https://github.com/Akaizoku/PSTK/releases/1.2.6) - 2024-10-07 + +Quality of life ### Added The following functions have been added: -- Ping-Host -- Show-EnvironmentVariables +- Ping-Host: Check connectivity to a specified host +- Show-EnvironmentVariables: Fetch environment variables +- Get-PowerShellError: Returns the latest error +- New-ProcessObject: Create standardised process object to monitor custom processes +- Update-ProcessObject: Update standardised process object to monitor custom processes + +### Changed + +The following functions have been updated: + +- Get-Properties: Now provides an option to pull metadata such as section and description +- Read-Properties: Now provides an option to pull metadata such as section and description +- Write-Log: Added notice message option + +### Fixed + +- Compare-Version: Fixed version comparison issues by using built-in version compare function when applciable ## [1.2.5](https://github.com/Akaizoku/PSTK/releases/1.2.5) - 2021-11-21 diff --git a/PSTK.psd1 b/PSTK.psd1 index 33e4dfb..e12f06c 100644 --- a/PSTK.psd1 +++ b/PSTK.psd1 @@ -3,7 +3,7 @@ # # Generated by: Florian Carrier # -# Generated on: 23/09/2024 +# Generated on: 24/09/2024 # @{ diff --git a/README.md b/README.md index 4f1fb09..3fe3d49 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ PowerShell Tool Kit (PSTK) is a library containing a collection of useful PowerS There are two methods of setting up the PowerShell Tool Kit module on your system: -1. Download the PSTK module from the [GitHub repository](https://github.com/Akaizoku/PSTK); -1. Install the PSTK module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/PSTK). +1. Download the PSTK module from the [GitHub repository](https://github.com/Akaizoku/PSTK) and extract it in the `PSModulePath` environment variable location; +2. Install the PSTK module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/PSTK). ```powershell Install-Module -Name "PSTK" -Repository "PSGallery" @@ -30,66 +30,71 @@ Get-Command -Module "PSTK" ``` | CommandType | Name | Version | Source | -| ----------- | --------------------------- | ------: | ------ | -| Function | Compare-Hashtable | 1.2.5 | PSTK | -| Function | Compare-Properties | 1.2.5 | PSTK | -| Function | Compare-Version | 1.2.5 | PSTK | -| Function | Complete-RelativePath | 1.2.5 | PSTK | -| Function | Confirm-Prompt | 1.2.5 | PSTK | -| Function | Convert-FileEncoding | 1.2.5 | PSTK | -| Function | ConvertTo-JavaProperty | 1.2.5 | PSTK | -| Function | ConvertTo-NaturalSort | 1.2.5 | PSTK | -| Function | ConvertTo-PDF | 1.2.5 | PSTK | -| Function | ConvertTo-RegularExpression | 1.2.5 | PSTK | -| Function | Copy-Object | 1.2.5 | PSTK | -| Function | Copy-OrderedHashtable | 1.2.5 | PSTK | -| Function | Expand-CompressedFile | 1.2.5 | PSTK | -| Function | Find-Key | 1.2.5 | PSTK | -| Function | Format-String | 1.2.5 | PSTK | -| Function | Get-CallerPreference | 1.2.5 | PSTK | -| Function | Get-EnvironmentVariable | 1.2.5 | PSTK | -| Function | Get-HTTPStatus | 1.2.5 | PSTK | -| Function | Get-KeyValue | 1.2.5 | PSTK | -| Function | Get-Object | 1.2.5 | PSTK | -| Function | Get-Path | 1.2.5 | PSTK | -| Function | Get-Properties | 1.2.5 | PSTK | -| Function | Get-URI | 1.2.5 | PSTK | -| Function | Import-CSVProperties | 1.2.5 | PSTK | -| Function | Import-Function | 1.2.5 | PSTK | -| Function | Import-Properties | 1.2.5 | PSTK | -| Function | Invoke-OracleCmd | 1.2.5 | PSTK | -| Function | New-DynamicParameter | 1.2.5 | PSTK | -| Function | New-RandomPassword | 1.2.5 | PSTK | -| Function | New-SelfContainedPackage | 1.2.5 | PSTK | -| Function | Out-Hashtable | 1.2.5 | PSTK | -| Function | Protect-WindowsCmdValue | 1.2.5 | PSTK | -| Function | Remove-EnvironmentVariable | 1.2.5 | PSTK | -| Function | Remove-Object | 1.2.5 | PSTK | -| Function | Rename-NumberedFile | 1.2.5 | PSTK | -| Function | Resolve-Array | 1.2.5 | PSTK | -| Function | Resolve-Boolean | 1.2.5 | PSTK | -| Function | Resolve-Tags | 1.2.5 | PSTK | -| Function | Resolve-URI | 1.2.5 | PSTK | -| Function | Select-XMLNode | 1.2.5 | PSTK | -| Function | Set-EnvironmentVariable | 1.2.5 | PSTK | -| Function | Set-RelativePath | 1.2.5 | PSTK | -| Function | Set-Tags | 1.2.5 | PSTK | -| Function | Start-Script | 1.2.5 | PSTK | -| Function | Stop-AllTranscripts | 1.2.5 | PSTK | -| Function | Stop-Script | 1.2.5 | PSTK | -| Function | Sync-EnvironmentVariable | 1.2.5 | PSTK | -| Function | Test-EnvironmentVariable | 1.2.5 | PSTK | -| Function | Test-HTTPStatus | 1.2.5 | PSTK | -| Function | Test-Object | 1.2.5 | PSTK | -| Function | Test-OracleConnection | 1.2.5 | PSTK | -| Function | Test-Service | 1.2.5 | PSTK | -| Function | Test-SQLConnection | 1.2.5 | PSTK | -| Function | Update-File | 1.2.5 | PSTK | -| Function | Wait-WebResource | 1.2.5 | PSTK | -| Function | Write-Checksum | 1.2.5 | PSTK | -| Function | Write-ErrorLog | 1.2.5 | PSTK | -| Function | Write-InsertOrUpdate | 1.2.5 | PSTK | -| Function | Write-Log | 1.2.5 | PSTK | +| :---------- | :-------------------------- | ------: | :----- | +| Function | Compare-Hashtable | 1.2.6 | PSTK | +| Function | Compare-Properties | 1.2.6 | PSTK | +| Function | Compare-Version | 1.2.6 | PSTK | +| Function | Complete-RelativePath | 1.2.6 | PSTK | +| Function | Confirm-Prompt | 1.2.6 | PSTK | +| Function | Convert-FileEncoding | 1.2.6 | PSTK | +| Function | ConvertTo-JavaProperty | 1.2.6 | PSTK | +| Function | ConvertTo-NaturalSort | 1.2.6 | PSTK | +| Function | ConvertTo-PDF | 1.2.6 | PSTK | +| Function | ConvertTo-RegularExpression | 1.2.6 | PSTK | +| Function | Copy-Object | 1.2.6 | PSTK | +| Function | Copy-OrderedHashtable | 1.2.6 | PSTK | +| Function | Expand-CompressedFile | 1.2.6 | PSTK | +| Function | Find-Key | 1.2.6 | PSTK | +| Function | Format-String | 1.2.6 | PSTK | +| Function | Get-CallerPreference | 1.2.6 | PSTK | +| Function | Get-EnvironmentVariable | 1.2.6 | PSTK | +| Function | Get-HTTPStatus | 1.2.6 | PSTK | +| Function | Get-KeyValue | 1.2.6 | PSTK | +| Function | Get-Object | 1.2.6 | PSTK | +| Function | Get-Path | 1.2.6 | PSTK | +| Function | Get-PowerShellError | 1.2.6 | PSTK | +| Function | Get-Properties | 1.2.6 | PSTK | +| Function | Get-URI | 1.2.6 | PSTK | +| Function | Import-CSVProperties | 1.2.6 | PSTK | +| Function | Import-Function | 1.2.6 | PSTK | +| Function | Import-Properties | 1.2.6 | PSTK | +| Function | Invoke-OracleCmd | 1.2.6 | PSTK | +| Function | New-DynamicParameter | 1.2.6 | PSTK | +| Function | New-ProcessObject | 1.2.6 | PSTK | +| Function | New-RandomPassword | 1.2.6 | PSTK | +| Function | New-SelfContainedPackage | 1.2.6 | PSTK | +| Function | Out-Hashtable | 1.2.6 | PSTK | +| Function | Ping-Host | 1.2.6 | PSTK | +| Function | Protect-WindowsCmdValue | 1.2.6 | PSTK | +| Function | Remove-EnvironmentVariable | 1.2.6 | PSTK | +| Function | Remove-Object | 1.2.6 | PSTK | +| Function | Rename-NumberedFile | 1.2.6 | PSTK | +| Function | Resolve-Array | 1.2.6 | PSTK | +| Function | Resolve-Boolean | 1.2.6 | PSTK | +| Function | Resolve-Tags | 1.2.6 | PSTK | +| Function | Resolve-URI | 1.2.6 | PSTK | +| Function | Select-XMLNode | 1.2.6 | PSTK | +| Function | Set-EnvironmentVariable | 1.2.6 | PSTK | +| Function | Set-RelativePath | 1.2.6 | PSTK | +| Function | Set-Tags | 1.2.6 | PSTK | +| Function | Show-EnvironmentVariables | 1.2.6 | PSTK | +| Function | Start-Script | 1.2.6 | PSTK | +| Function | Stop-AllTranscripts | 1.2.6 | PSTK | +| Function | Stop-Script | 1.2.6 | PSTK | +| Function | Sync-EnvironmentVariable | 1.2.6 | PSTK | +| Function | Test-EnvironmentVariable | 1.2.6 | PSTK | +| Function | Test-HTTPStatus | 1.2.6 | PSTK | +| Function | Test-Object | 1.2.6 | PSTK | +| Function | Test-OracleConnection | 1.2.6 | PSTK | +| Function | Test-Service | 1.2.6 | PSTK | +| Function | Test-SQLConnection | 1.2.6 | PSTK | +| Function | Update-File | 1.2.6 | PSTK | +| Function | Update-ProcessObject | 1.2.6 | PSTK | +| Function | Wait-WebResource | 1.2.6 | PSTK | +| Function | Write-Checksum | 1.2.6 | PSTK | +| Function | Write-ErrorLog | 1.2.6 | PSTK | +| Function | Write-InsertOrUpdate | 1.2.6 | PSTK | +| Function | Write-Log | 1.2.6 | PSTK | ## Dependencies