From ef810b0aa7c732861beb9778c8a25e6da37e27d7 Mon Sep 17 00:00:00 2001 From: Glenn Date: Sun, 20 Nov 2022 16:29:06 +0100 Subject: [PATCH] doc: Update README --- README.md | 29 ++++++++++++----------------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 225dd44..71c2197 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,33 @@ -Role Name -========= +# glenux.basesystem (ansible role) A brief description of the role goes here. -Requirements ------------- +## Requirements Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. -Role Variables --------------- +## Role Variables A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. -Dependencies ------------- +## Dependencies A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. -Example Playbook ----------------- +## Example Playbook Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: - - hosts: servers - roles: - - { role: username.rolename, x: 42 } +```yaml +- hosts: servers + roles: + - { role: glenux.basesystem, x: 42 } +``` -License -------- +## License BSD -Author Information ------------------- +## Author Information An optional section for the role authors to include contact information, or a website (HTML is not allowed).