@settlemint/sdk-cli 1.0.4-pre31846e1 → 1.0.5-main3bd9929d

package/README.md

@@ -30,6 +30,7 @@
 - [Usage](#usage)
   - [As a dependency in your package.json](#as-a-dependency-in-your-package.json)
   - [Globally install the CLI](#globally-install-the-cli)
+- [GitHub Action](#github-action)
 - [Examples](#examples)
   - [Get the version of the CLI](#get-the-version-of-the-cli)
   - [Get help for a command](#get-help-for-a-command)
@@ -89,6 +90,25 @@ pnpm install -g @settlemint/sdk-cli
 yarn install -g @settlemint/sdk-cli
 ```
 
+You can access the CLI globally by running `settlemint` in your terminal.
+
+## GitHub Action
+
+Execute SettleMint CLI commands directly in your GitHub Actions workflows using our official GitHub Action.
+
+For detailed setup and usage instructions, check out our [documentation](https://github.com/settlemint/settlemint-action/blob/main/README.md).
+
+Basic example:
+
+```yaml
+steps:
+  - name: Get SettleMint CLI version
+    uses: settlemint/settlemint-action@main
+    with:
+      access-token: ${{ secrets.SETTLEMINT_ACCESS_TOKEN }}
+      command: "--version"
+```
+
 ## Examples
 
 ### Get the version of the CLI
@@ -229,7 +249,7 @@ settlemint scs subgraph deploy --accept-defaults <subgraph-name>
 
 ## API Reference
 
-See the [documentation](https://github.com/settlemint/sdk/tree/v1.0.4/sdk/cli/docs/settlemint.md) for available commands.
+See the [documentation](https://github.com/settlemint/sdk/tree/v1.0.5/sdk/cli/docs/settlemint.md) for available commands.
 
 ## Contributing