@settlemint/sdk-cli 1.0.5-mainddf9eef6 → 1.0.5-pr765590bf

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -30,6 +30,7 @@
30
30
  - [Usage](#usage)
31
31
  - [As a dependency in your package.json](#as-a-dependency-in-your-package.json)
32
32
  - [Globally install the CLI](#globally-install-the-cli)
33
+ - [GitHub Action](#github-action)
33
34
  - [Examples](#examples)
34
35
  - [Get the version of the CLI](#get-the-version-of-the-cli)
35
36
  - [Get help for a command](#get-help-for-a-command)
@@ -89,6 +90,25 @@ pnpm install -g @settlemint/sdk-cli
89
90
  yarn install -g @settlemint/sdk-cli
90
91
  ```
91
92
 
93
+ You can access the CLI globally by running `settlemint` in your terminal.
94
+
95
+ ## GitHub Action
96
+
97
+ Execute SettleMint CLI commands directly in your GitHub Actions workflows using our official GitHub Action.
98
+
99
+ For detailed setup and usage instructions, check out our [documentation](https://github.com/settlemint/settlemint-action/blob/main/README.md).
100
+
101
+ Basic example:
102
+
103
+ ```yaml
104
+ steps:
105
+ - name: Get SettleMint CLI version
106
+ uses: settlemint/settlemint-action@main
107
+ with:
108
+ access-token: ${{ secrets.SETTLEMINT_ACCESS_TOKEN }}
109
+ command: "--version"
110
+ ```
111
+
92
112
  ## Examples
93
113
 
94
114
  ### Get the version of the CLI