From ccf43e23d95c966e23ed56aaafb41841547abf62 Mon Sep 17 00:00:00 2001
From: Simon Cornet <simon@simoncor.net>
Date: Sun, 10 May 2026 14:15:39 +0200
Subject: [PATCH] docs: add required variables to readme

---
 readme.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/readme.md b/readme.md
index 26e64a4..0df5299 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,21 @@
 # Ansible Role: Woodpecker CI
 
 Install and configure [Woodpecker CI](https://woodpecker-ci.org) - a simple yet powerful CI/CD engine with great extensibility.
+
+## Variables
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `woodpecker_forgejo_client` | Yes | - | Forgejo OAuth2 client ID |
+| `woodpecker_forgejo_secret` | Yes | - | Forgejo OAuth2 client secret |
+| `woodpecker_agent_secret` | Yes | - | Shared secret for agent authentication |
+| `timezone` | No | - | Timezone for the container |
+
+## Example
+
+```yaml
+woodpecker_forgejo_client: "your-oauth2-client-id"
+woodpecker_forgejo_secret: "your-oauth2-client-secret"
+woodpecker_agent_secret: "your-agent-secret"
+timezone: "Europe/Amsterdam"
+```