From 50511720eb7da6412d01405f48ba5084010096ed Mon Sep 17 00:00:00 2001
From: Markus Pesch <markus.pesch@cryptic.systems>
Date: Thu, 8 May 2025 12:23:22 +0200
Subject: [PATCH] docs(README): add example

---
 .markdownlint.yaml |  8 +++-----
 README.md          | 18 ++++++++++++++++++
 2 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/.markdownlint.yaml b/.markdownlint.yaml
index 57b2fbf..6180a73 100644
--- a/.markdownlint.yaml
+++ b/.markdownlint.yaml
@@ -45,19 +45,17 @@ MD012:
 # MD013/line-length - Line length
 MD013:
   # Number of characters
-  line_length: 80
+  line_length: 120
   # Number of characters for headings
-  heading_line_length: 80
+  heading_line_length: 120
   # Number of characters for code blocks
-  code_block_line_length: 80
+  code_block_line_length: 120
   # Include code blocks
   code_blocks: false
   # Include tables
   tables: false
   # Include headings
   headings: true
-  # Include headings
-  headers: true
   # Strict length checking
   strict: false
   # Stern length checking
diff --git a/README.md b/README.md
index f7db48c..d4c5d49 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,21 @@
 # ansible
 
 [![Docker Pulls](https://img.shields.io/docker/pulls/volkerraschek/ansible-archlinux)](https://hub.docker.com/r/volkerraschek/ansible-archlinux)
+
+This container image can be used to execute ansible. It contains the latest versions of ansible-core, ansible-lint and
+python-boto3 to interact with AWS dynamic inventory.
+
+Here is an example. The environment variables as well as the path to the playbook and inventory must of course be
+adapted to your own needs.
+
+```bash
+docker run \
+  --env AWS_ACCESS_KEY_ID \
+  --env AWS_SECRET_ACCESS_KEY \
+  --env AWS_SESSION_TOKEN \
+  --rm \
+  --volume $(pwd):$(pwd) \
+  --workdir $(pwd) \
+    git.cryptic.systems/volkerraschek/ansible:latest \
+      bash -c "ansible-galaxy install -r requirements.yaml && ansible-playbook -i inventories/demo.aws_ec2.yaml aws.yaml"
+```