Adding an "Example Playbook" section to the README template for ansible-galaxy

Fixes 5397
11 years ago · fc30467593
parent 593098108e
commit fc30467593
1 changed files with 9 additions and 0 deletions
--- a/bin/ansible-galaxy
+++ b/bin/ansible-galaxy
@ -107,6 +107,15 @@ 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
+-------------------------
+
+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 }
+
 License
 -------