From 0159e1237712ccf5c39d1cb72acaeb115f4f223b Mon Sep 17 00:00:00 2001
From: ci-bot <ci-bot@rknet.org>
Date: Sun, 18 Feb 2024 12:18:54 +0000
Subject: [PATCH] [skip ci] automated docs update

---
 README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)

diff --git a/README.md b/README.md
index b72d04b..3e30fef 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,74 @@
 # xoxys.lvm
+
+[![Build Status](https://ci.rknet.org/api/badges/ansible/xoxys.lvm/status.svg)](https://ci.rknet.org/repos/ansible/xoxys.lvm)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.lvm/src/branch/main/LICENSE)
+
+Configure a list of LVM volumes.
+
+## Table of content
+
+- [Requirements](#requirements)
+- [Default Variables](#default-variables)
+  - [lvm_packages](#lvm_packages)
+  - [lvm_volumes](#lvm_volumes)
+- [Dependencies](#dependencies)
+- [License](#license)
+- [Author](#author)
+
+---
+
+## Requirements
+
+- Minimum Ansible version: `2.1`
+
+## Default Variables
+
+### lvm_packages
+
+#### Default value
+
+```YAML
+lvm_packages:
+  - lvm2
+```
+
+### lvm_volumes
+
+Define a list of LVM volumes. The `state` parameter is related to the possible state values
+of Ansibles [mount](https://docs.ansible.com/ansible/latest/collections/ansible/posix/mount_module.html) module.
+
+#### Default value
+
+```YAML
+lvm_volumes: []
+```
+
+#### Example usage
+
+```YAML
+lvm_volumes:
+  - name: lv_data
+    group: vg_data
+    disks:
+      - /dev/sda
+    fstype: ext4
+    size: 100g
+    resizefs: True
+    mountpoint: /mnt/data
+    mountopts:
+      - ro
+      - noauto
+    state: mounted
+```
+
+## Dependencies
+
+None.
+
+## License
+
+MIT
+
+## Author
+
+[Robert Kaussow](https://gitea.rknet.org/xoxys)