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

---
 README.md | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f45ed61..472a0e5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,26 @@
 # fast_submodule_checkout
-Updates or clones a submodule much faster by enabling caching
+GitHub action to update or clone a submodule much faster by enabling caching
+
+## 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: Fast Submodule Checkout libs/corelib
+      uses: 0xFEEDC0DE64/fast_submodule_checkout@main
+      with:
+        submodule: libs/corelib
+
+    - name: Use corelib
+      run: ls -lah libs/corelib
+```
+