diff --git a/README.md b/README.md index d1adf3c..0c26407 100644 --- a/README.md +++ b/README.md @@ -8,24 +8,24 @@ To get started with your own GitHub PowerShell based action, [create a new repos ### Inputs -| Name | Description | Required | Default | -|--------------------|---------------------------------------------------------------------------|----------|-----------------------| -| `Name` | The name of the action. | false | `GitHub-Script` | -| `Script` | The script to run. Can be inline, multi-line, or a path to a script file. | false | | -| `Token` | Log in using an Installation Access Token (IAT). | false | `${{ github.token }}` | -| `ClientID` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | -| `PrivateKey` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | -| `KeyVaultKeyReference` | Log in using a GitHub App, with the App's Client ID and KeyVault Key Reference. | false | | -| `Debug` | Enable debug output for the whole action. | false | `'false'` | -| `Verbose` | Enable verbose output for the whole action. | false | `'false'` | -| `Version` | Specifies the exact version of the GitHub module to install. | false | | -| `Prerelease` | Allow prerelease versions if available. | false | `'false'` | -| `ErrorView` | Configure the PowerShell `$ErrorView` variable. You can use full names ('NormalView', 'CategoryView', 'ConciseView', 'DetailedView'). It matches on partials. | false | `'NormalView'` | -| `ShowInfo` | Show information about the environment. | false | `'true'` | -| `ShowInit` | Show information about the initialization. | false | `'false'` | -| `ShowOutput` | Show the script's output. | false | `'false'` | -| `WorkingDirectory` | The working directory where the script runs. | false | `'.'` | -| `PreserveCredentials` | Preserve credentials after script execution. If false, disconnects GitHub contexts and CLI using Disconnect-GitHubAccount. | false | `'true'` | +| Name | Description | Required | Default | +|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-----------------------| +| `Name` | The name of the action. | false | `GitHub-Script` | +| `Script` | The script to run. Can be inline, multi-line, or a path to a script file. | false | | +| `Token` | Log in using an Installation Access Token (IAT). | false | `${{ github.token }}` | +| `ClientID` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | +| `PrivateKey` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | +| `KeyVaultKeyReference` | Log in using a GitHub App, with the App's Client ID and KeyVault Key Reference. | false | | +| `Debug` | Enable debug output for the whole action. | false | `'false'` | +| `Verbose` | Enable verbose output for the whole action. | false | `'false'` | +| `Version` | Specifies the exact version of the GitHub module to install. | false | | +| `Prerelease` | Allow prerelease versions if available. | false | `'false'` | +| `ErrorView` | Configure the PowerShell `$ErrorView` variable. You can use full names ('NormalView', 'CategoryView', 'ConciseView', 'DetailedView'). It matches on partials. | false | `'NormalView'` | +| `ShowInfo` | Show information about the environment. | false | `'true'` | +| `ShowInit` | Show information about the initialization. | false | `'false'` | +| `ShowOutput` | Show the script's output. | false | `'false'` | +| `WorkingDirectory` | The working directory where the script runs. | false | `'.'` | +| `PreserveCredentials` | Preserve credentials after script execution. If false, disconnects GitHub contexts and CLI using Disconnect-GitHubAccount. | false | `'true'` | ### Outputs