From b8585b38b7655c930b61734b570ce0c557ee45b9 Mon Sep 17 00:00:00 2001
From: Johanna Dorothea Reichmann <transcaffeine@finally.coffee>
Date: Wed, 26 Jul 2023 19:58:21 +0200
Subject: [PATCH] chore(git): add role-README, update collection README

---
 README.md           |  1 +
 roles/git/README.md | 19 +++++++++++++++++++
 2 files changed, 20 insertions(+)
 create mode 100644 roles/git/README.md

diff --git a/README.md b/README.md
index 6cc790a..d80638e 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,7 @@
 This ansible collection provides various roles for installing
 and configuring basic system utilities like gnupg, ssh etc
 
+- [`git`](roles/git/README.md): configures git on the target system
 - [`nginx`](roles/nginx/README.md): [nginx](https://www.nginx.com/),
   an advanced load balancer, webserver and reverse proxy.
 
diff --git a/roles/git/README.md b/roles/git/README.md
new file mode 100644
index 0000000..2b13ca7
--- /dev/null
+++ b/roles/git/README.md
@@ -0,0 +1,19 @@
+# `finallycoffee.base.git` ansible role
+
+This role configures git for the `ansible_user` and can be used
+to (pre)-configure git.
+
+## Examples
+
+```yaml
+
+git_config_user_name: # user name to use for git
+git_config_user_email: # email to use for git
+
+git_config_core_editor: vim # editor to use
+
+git_config_credentials:
+  - remote_url: https://github.com
+    config:
+      username: my_github_username
+```