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

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

diff --git a/readme.md b/readme.md
index d53818e..42699b8 100644
--- a/readme.md
+++ b/readme.md
@@ -1,13 +1,23 @@
-# Overview
+# Ansible Role: Atuin
 
-This role configures [Atuin](<https://atuin.sh/>) server, for reasons.
+Install and configure [Atuin](https://atuin.sh/) - a shell history sync server.
 
-## Supported Operating Systems
+## Variables
 
-| Operating System | Version |
-| --- | ----- |
-| Debian | 13 |
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `atuin_version` | No | `18.13.6` | Atuin version to install |
+| `atuin_db_host` | No | `localhost` | Database host |
+| `atuin_db_name` | No | `atuin` | Database name |
+| `atuin_db_user` | No | `atuin` | Database user |
+| `atuin_db_pass` | Yes | `atuin` | Database password |
 
-## Tags
+## Example
 
-This role has no tags.
+```yaml
+atuin_version: "18.13.6"
+atuin_db_host: "localhost"
+atuin_db_name: "atuin"
+atuin_db_user: "atuin"
+atuin_db_pass: "secure_password"
+```