Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
philipparndt authored Sep 6, 2024
1 parent 3b786ed commit e8f1371
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# setup-vehub

This action sets up the veHub CLI, so that it can be used in subsequent steps.
This action sets up the veHub CLI to be used in subsequent steps in your workflow.

You can find more details on how to use the CLI here: [vehub.vector.com/docs/cli/](https://vehub.vector.com/docs/cli/).

## Usage

Example usage:

```yaml
# ...
steps:
- name: Setup veHub CLI
uses: vehub/setup-vehub@v1
Expand All @@ -19,3 +22,8 @@ steps:
env:
VEHUB_TOKEN: ${{ secrets.VEHUB_TOKEN }}
```
## Limitations
The action is currently supported on Linux runners.
However, the CLI is also available for other platforms. When you need support for Windows or macOS, you can open a ticket.

0 comments on commit e8f1371

Please sign in to comment.