chore(git): add role-README, update collection README

2023-07-26 19:58:21 +02:00
parent f9a0f92e27
commit b8585b38b7
2 changed files with 20 additions and 0 deletions
--- a/roles/git/README.md
+++ 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
+```