summaryrefslogtreecommitdiff
path: root/bin/ansible-galaxy
diff options
context:
space:
mode:
authorJames Cammarata <jcammarata@ansibleworks.com>2014-01-24 15:39:30 -0600
committerJames Cammarata <jcammarata@ansibleworks.com>2014-01-24 15:39:30 -0600
commitfc3046759345a88436cadfeea5e6570b9eef3e7e (patch)
tree580014c32b5ee1ff8d66a92eff23789c13624b94 /bin/ansible-galaxy
parent593098108ea10e2e435208897a1ec4c5d986ce3a (diff)
downloadansible-fc3046759345a88436cadfeea5e6570b9eef3e7e.tar.gz
Adding an "Example Playbook" section to the README template for ansible-galaxy
Fixes 5397
Diffstat (limited to 'bin/ansible-galaxy')
-rwxr-xr-xbin/ansible-galaxy9
1 files changed, 9 insertions, 0 deletions
diff --git a/bin/ansible-galaxy b/bin/ansible-galaxy
index 6fab3ed80b..f46b9fd96e 100755
--- 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
-------