🩹 [Patch]: Module now ships a single Get-Toml command

.github/workflows/Process-PSModule.yml

@@ -27,6 +27,6 @@ permissions:
 
 jobs:
   Process-PSModule:
-    uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@11117919e65242d3388727819a751f74ad24ea9e # v5.5.0
+    uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@fb1bdb8fefd243292f779d2a856a38db6fe6daf4 # v6.1.13
     secrets:
       APIKEY: ${{ secrets.APIKEY }}

README.md

@@ -1,69 +1,31 @@
-# {{ NAME }}
+# Toml
 
-{{ DESCRIPTION }}
-
-## Prerequisites
-
-This uses the following external resources:
-- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module.
+Toml is a PowerShell module for reading TOML file content from disk so scripts can load and process configuration text.
 
 ## Installation
 
-To install the module from the PowerShell Gallery, you can use the following command:
-
-```powershell
-Install-PSResource -Name {{ NAME }}
-Import-Module -Name {{ NAME }}
-```
-
-## Usage
-
-Here is a list of example that are typical use cases for the module.
-
-### Example 1: Greet an entity
-
-Provide examples for typical commands that a user would like to do with the module.
+Install the module from the PowerShell Gallery:
 
 ```powershell
-Greet-Entity -Name 'World'
-Hello, World!
+Install-PSResource -Name Toml
+Import-Module -Name Toml
 ```
 
-### Example 2
+## Capabilities
 
-Provide examples for typical commands that a user would like to do with the module.
+Use this command to read TOML content from a file path:
 
 ```powershell
-Import-Module -Name PSModuleTemplate
+Get-Toml -Path '.\settings.toml'
 ```
 
-### Find more examples
-
-To find more examples of how to use the module, please refer to the [examples](examples) folder.
-
-Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module.
-To find examples of each of the commands you can use Get-Help -Examples 'CommandName'.
-
 ## Documentation
 
-Link to further documentation if available, or describe where in the repository users can find more detailed documentation about
-the module's functions and features.
-
-## Contributing
-
-Coder or not, you can contribute to the project! We welcome all contributions.
-
-### For Users
+Documentation is published at [psmodule.io/Toml](https://psmodule.io/Toml/).
 
-If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
-product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
-Please see the issues tab on this project and submit a new issue that matches your needs.
+Use PowerShell help and command discovery for details:
 
-### For Developers
-
-If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information.
-You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement.
-
-## Acknowledgements
-
-Here is a list of people and projects that helped this project in some way.
+```powershell
+Get-Command -Module Toml
+Get-Help -Name Get-Toml -Examples
+```

src/functions/public/Toml/Get-Toml.ps1

@@ -0,0 +1,36 @@
+function Get-Toml {
+    <#
+        .SYNOPSIS
+        Get TOML content from a file.
+
+        .DESCRIPTION
+        Reads a TOML file from disk and returns its raw text content as a single string.
+
+        .EXAMPLE
+        Get-Toml -Path '.\settings.toml'
+        Returns the TOML content from settings.toml as a string.
+
+        .INPUTS
+        [string]
+
+        .OUTPUTS
+        [string]
+
+        .NOTES
+        This command returns raw TOML text and does not parse TOML into objects.
+
+        .LINK
+        https://github.com/PSModule/Toml
+    #>
+    [OutputType([string])]
+    [CmdletBinding()]
+    param(
+        # Path to the TOML file.
+        [Parameter(Mandatory, Position = 0)]
+        [ValidateNotNullOrEmpty()]
+        [string] $Path
+    )
+
+    $resolvedPath = $PSCmdlet.GetUnresolvedProviderPathFromPSPath($Path)
+    [System.IO.File]::ReadAllText($resolvedPath)
+}

src/functions/public/Toml/Toml.md

@@ -0,0 +1,7 @@
+# Toml
+
+Public commands for reading TOML content from files.
+
+## Commands
+
+- `Get-Toml`: Reads TOML file content and returns it as raw text.