From 00025dc317ab721ae38ee33a9e0eb74411d4c828 Mon Sep 17 00:00:00 2001
From: Tobias Bauriedel <tobias.bauriedel@netways.de>
Date: Thu, 28 Dec 2023 23:05:24 +0100
Subject: [PATCH] add docs

---
 README.md                |  6 ++++--
 roles/influxdb/README.md | 24 ++++++++++++++++++++++++
 roles/repos/README.md    | 20 ++++++++++++++++++++
 3 files changed, 48 insertions(+), 2 deletions(-)
 create mode 100644 roles/influxdb/README.md
 create mode 100644 roles/repos/README.md

diff --git a/README.md b/README.md
index 31ce93e..9c4febb 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+![Lint](https://github.com/tbauriedel/ansible-collection-influxdb/actions/workflows/yamllint.yml/badge.svg)
+
 > **Note:** Collection is work in progress
 
 # ansible-collection-influxdb
@@ -16,5 +18,5 @@ It was created with the aim of refreshing my Ansible knowledge and getting in to
 
 ## Roles
 
-* repos
-* influxdb
+* [Role: repos](roles/repos/README.md) (add repositories)
+* [Role: influxdb](roles/influxdb/README.md) (install and configure influxdb)
diff --git a/roles/influxdb/README.md b/roles/influxdb/README.md
new file mode 100644
index 0000000..823ee17
--- /dev/null
+++ b/roles/influxdb/README.md
@@ -0,0 +1,24 @@
+# influxdb.influxdb
+
+## Description
+
+With that role you can install and configure InfluxDB.
+At the moment the configuration is very basic. Over time, this role will be expanded.
+
+## Variables
+
+* `influxdb_influxdb_bolt_path`: InfluxDB bolt-path
+* `influxdb_influxdb_engine_path`: InfluxDB engine-path
+
+Defaults can be viewed in vars/defaults.yml
+
+## Example
+
+Install the official InfluxDB repository:
+```
+- hosts: all
+  become: true
+
+  roles:
+    - influxdb
+```
\ No newline at end of file
diff --git a/roles/repos/README.md b/roles/repos/README.md
new file mode 100644
index 0000000..0600b6f
--- /dev/null
+++ b/roles/repos/README.md
@@ -0,0 +1,20 @@
+# influxdb.repos
+
+## Description
+
+With that role the official [InfluxDB repository](https://repos.influxdata.com) and signing key will be installed.
+
+## Variables
+
+Defaults can be viewed in vars/defaults.yml
+
+## Example
+
+Install the official InfluxDB repository:
+```
+- hosts: all
+  become: true
+
+  roles:
+    - repos
+```
\ No newline at end of file