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

---
 readme.md | 102 ++++++++++++++++++++++++++++--------------------------
 1 file changed, 52 insertions(+), 50 deletions(-)

diff --git a/readme.md b/readme.md
index 65b1114..b64d9c5 100644
--- a/readme.md
+++ b/readme.md
@@ -1,59 +1,61 @@
-# Overview
+# Ansible Role: Common
 
-This role manages the build-in 'core' Operating System components and defaults tailored for Siempie.  
+Manage core Operating System components and system defaults.
 
-## Supported Operating Systems
+## Variables
 
-| Operating System | Version |
-| --- | ----- |
-| Debian | 13 |
-| Debian | 13 |
-| Ubuntu | 22 LTS |
-| Ubuntu | 24 LTS |
+### APT Configuration
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `apt_automatic_reboot_time` | No | `04:00` | Automated reboot time |
+| `apt_automatic_reboot` | No | `true` | Enable automated reboots |
+| `apt_enable_multiverse` | No | `false` | Enable multiverse repository |
+| `apt_enable_universe` | No | `true` | Enable universe repository |
+| `apt_repository` | No | `https://archive.ubuntu.com/ubuntu` | APT repository URL (Ubuntu 22) |
+| `apt_repository_main` | No | `https://archive.ubuntu.com/ubuntu` | Main APT repository (Ubuntu 24+) |
+| `apt_repository_security` | No | `https://archive.ubuntu.com/ubuntu` | Security APT repository (Ubuntu 24+) |
+
+### NTP Configuration
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `ntp_server` | No | `pool.ntp.org` | NTP server for time synchronization |
+| `timezone` | No | `Europe/Amsterdam` | System timezone |
 
 ## Tags
 
-- apt
-- apt-cleanup
-- apt-update
-- cron
-- environment-file
-- hostname
-- hostfile
-- firewall
-- journald
-- locale
-- lldp
-- lxd
-- motd
-- ntp
-- telemetry
-- snap
-- sshd
-- swap
-- sysctl
-- systemctl
-- syslog
-- timezone
-- usermanagement
+Available tags for selective execution:
 
-## vars
+- `apt` - APT package management
+- `apt-cleanup` - Clean APT cache
+- `apt-update` - Update APT packages
+- `cron` - Configure cron
+- `environment-file` - Manage environment files
+- `hostname` - Set hostname
+- `hostfile` - Manage /etc/hosts
+- `firewall` - Configure firewall
+- `journald` - Configure journald
+- `locale` - Set system locale
+- `lldp` - Configure LLDP
+- `lxd` - Configure LXD
+- `motd` - Set message of the day
+- `ntp` - Configure NTP
+- `telemetry` - Configure telemetry
+- `snap` - Manage snap packages
+- `sshd` - Configure SSH daemon
+- `swap` - Configure swap
+- `sysctl` - Manage sysctl settings
+- `systemctl` - Manage systemd services
+- `syslog` - Configure syslog
+- `timezone` - Set timezone
+- `usermanagement` - Manage users
 
-### apt
+## Example
 
-| variable | type | value(default) | comment |
-| --- | --- | --- | --- |
-| apt_automatic_reboot_time | string | 04:00 | Automated reboot at 04:00 |
-| apt_automatic_reboot | boolean | true | Toggle automated reboots |
-| apt_enable_multiverse | boolean | false | Toggle multiverse repository |
-| apt_enable_universe | boolean | true | Toggle universe repository |
-| apt_repository | string | <https://archive.ubuntu.com/ubuntu> | Ubuntu 22 |
-| apt_repository_main | string | <https://archive.ubuntu.com/ubuntu> | Ubuntu 24+ |
-| apt_repository_security | string | <https://archive.ubuntu.com/ubuntu> | Ubuntu 24+ |
-
-### ntp
-
-| variable | type | value(default) | comment |
-| --- | --- | --- | --- |
-| ntp_server | string | pool.ntp.org | NTP server to sync time with |
-| timezone | string | Europe/Amsterdam | Select the timezone |
+```yaml
+apt_automatic_reboot: true
+apt_automatic_reboot_time: "03:00"
+ntp_server: "time.cloudflare.com"
+timezone: "UTC"
+```