From 129aa965d1ad7b33fadd7c0ebfd5937e6b0db756 Mon Sep 17 00:00:00 2001
From: Philipp Arndt <philipp.arndt@vector.com>
Date: Fri, 6 Sep 2024 08:51:39 +0200
Subject: [PATCH] docs: add example

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8cd77f6..c888dcb 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,21 @@
-# setup-vehub
\ No newline at end of file
+# setup-vehub
+
+This action sets up the veHub CLI, so that it can be used in subsequent steps.
+
+## Usage
+
+Example usage:
+
+```yaml
+steps:
+  - name: Setup veHub CLI
+    uses: vehub/setup-vehub@v1
+
+  - name: Check installation
+    run: vehub --version
+    
+  - name: List project spaces
+    run: vehub space list
+    env:
+      VEHUB_TOKEN: ${{ secrets.VEHUB_TOKEN }}
+```