From 1681935a5e8e8fff7ce270a9af07d3f3128e78fe Mon Sep 17 00:00:00 2001
From: Louis Seubert <louis.seubert.ls@gmail.com>
Date: Sun, 5 Oct 2025 20:47:59 +0200
Subject: [PATCH] chore: add readme example

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

diff --git a/README.md b/README.md
index 4642dd4..e2a0fa8 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,15 @@
 # checkout
+
+```yaml
+uses: actions/checkout:1.0.0
+with:
+  # The path to the repository to checkout. Must be accessible with the pipeline
+  # token on publiclly
+  repository: ${{ github.server_url }}/${{ github.repository }}.git
+  # Relative path under $GITHUB_WORKSPACE to place the repository
+  path: .
+  # The branch, tag or SHA to checkout. When checking out the repository that
+  # triggered a workflow, this defaults to the reference or SHA for that event.
+  # Otherwise, uses the default branch.
+  ref: ${{ github.ref || github.sha }}
+```