From ad79fcc93f81f32343b342db560fa90162c42c58 Mon Sep 17 00:00:00 2001
From: Daniel Brunner <daniel@brunner.ninja>
Date: Sat, 18 Sep 2021 22:39:48 +0200
Subject: [PATCH] Add example workflow

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 8b97652..3e7b7ff 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,26 @@
 # get_submodule_hash
 GitHub action to get the hash of a submodule
+
+## Example workflow
+
+```yaml
+name: Getting the hash of the corelib submodule
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Get submodule hash
+      id: get-submodule-hash
+      uses: 0xFEEDC0DE64/get_submodule_hash
+      with:
+        submodule: libs/corelib
+
+    - name: Print submodule hash
+      run: echo "hash of submodule is ${{ steps.get-submodule-hash.outputs.hash }}"
+```