From 17f2fed092e07516c47bb439893513f4d99c0085 Mon Sep 17 00:00:00 2001
From: Simon Cornet <simon@simoncor.net>
Date: Fri, 10 Apr 2026 09:00:13 +0200
Subject: [PATCH] docs: standardize readme format

---
 readme.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/readme.md b/readme.md
index b70b900..f0978ea 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,15 @@
-# Overview
+# Ansible Role: Log Forwarder
 
-This role configures the VMware Log Insight Agent.
+Install and configure Splunk Universal Forwarder for log forwarding.
+
+## Variables
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `splunk_forwarder_deb` | Yes | `https://download.splunk.com/...` | URL to Splunk Universal Forwarder DEB package |
+
+## Example
+
+```yaml
+splunk_forwarder_deb: "https://download.splunk.com/products/universalforwarder/releases/9.4.2/linux/splunkforwarder-9.4.2-e9664af3d956-linux-amd64.deb"
+```