From 8acee03d35d90e8a679f9525dfccd744b1d12bae Mon Sep 17 00:00:00 2001
From: Simon Cornet <simon@simoncor.net>
Date: Fri, 8 May 2026 17:21:51 +0200
Subject: [PATCH] docs: add sync credentials example

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

diff --git a/readme.md b/readme.md
index 8bf3a96..2506122 100644
--- a/readme.md
+++ b/readme.md
@@ -10,6 +10,16 @@ Install and configure [Zot](https://zotregistry.dev/) - an OCI-native container
 | `zot_cve_scanning` | No | `false` | Enable CVE scanning of images |
 | `zot_sync_credentials` | No | undefined | List of sync registry credentials (name, registry, username, password) to avoid rate limits |
 
+## Example
+
+```yaml
+zot_sync_credentials:
+  - name: "dockerhub"
+    registry: "registry-1.docker.io"
+    username: "your-dockerhub-username"
+    password: "your-dockerhub-password"
+```
+
 ## Configuration
 
 The role deploys Zot with the following defaults: