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 +```