Skip to content

Commit a763554

Browse files
committed
Update README.md
1 parent 10e8beb commit a763554

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ A PowerShell module to provide a better and easier way for GitHub Actions to com
2929
#### Install
3030

3131
- PowerShell >= v7.2.0
32+
- NodeJS >= v14.15.0 (only for NodeJS wrapper API)
33+
- NPM >= v6.14.8 (only for NodeJS wrapper API)
3234

3335
```ps1
3436
Install-Module -Name 'hugoalh.GitHubActionsToolkit' -AcceptLicense
@@ -44,6 +46,11 @@ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scop
4446

4547
### API (Excerpt)
4648

49+
| **Legend** | **Description** |
50+
|:-:|:--|
51+
| 🧪 | **Experimental:** Experimental API. |
52+
| 🔘 | **NodeJS Wrapper:** Wrapper API, require NodeJS as dependency. |
53+
4754
#### Function
4855

4956
- `Add-GitHubActionsPATH`
@@ -61,24 +68,24 @@ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scop
6168
- `Enable-GitHubActionsProcessingCommands`
6269
- `Enter-GitHubActionsLogGroup`
6370
- `Exit-GitHubActionsLogGroup`
64-
- `Expand-GitHubActionsToolCacheCompressedFile` 🧪
65-
- `Export-GitHubActionsArtifact` 🧪
66-
- `Find-GitHubActionsToolCache` 🧪
71+
- `Expand-GitHubActionsToolCacheCompressedFile` 🧪🔘
72+
- `Export-GitHubActionsArtifact` 🧪🔘
73+
- `Find-GitHubActionsToolCache` 🧪🔘
6774
- `Get-GitHubActionsInput`
6875
- `Get-GitHubActionsIsDebug`
6976
- `Get-GitHubActionsOpenIdConnectToken` 🧪
7077
- `Get-GitHubActionsState`
7178
- `Get-GitHubActionsStepSummary`
7279
- `Get-GitHubActionsWebhookEventPayload`
7380
- `Get-GitHubActionsWorkflowRunUri`
74-
- `Import-GitHubActionsArtifact` 🧪
75-
- `Invoke-GitHubActionsToolCacheToolDownloader` 🧪
76-
- `Register-GitHubActionsToolCacheDirectory` 🧪
77-
- `Register-GitHubActionsToolCacheFile` 🧪
81+
- `Import-GitHubActionsArtifact` 🧪🔘
82+
- `Invoke-GitHubActionsToolCacheToolDownloader` 🧪🔘
83+
- `Register-GitHubActionsToolCacheDirectory` 🧪🔘
84+
- `Register-GitHubActionsToolCacheFile` 🧪🔘
7885
- `Remove-GitHubActionsProblemMatcher`
7986
- `Remove-GitHubActionsStepSummary`
80-
- `Restore-GitHubActionsCache` 🧪
81-
- `Save-GitHubActionsCache` 🧪
87+
- `Restore-GitHubActionsCache` 🧪🔘
88+
- `Save-GitHubActionsCache` 🧪🔘
8289
- `Set-GitHubActionsEnvironmentVariable`
8390
- `Set-GitHubActionsOutput`
8491
- `Set-GitHubActionsState`

0 commit comments

Comments
 (0)