From 74f2025729c0d9a30e755ea354b9ad4357aa5e2e Mon Sep 17 00:00:00 2001 From: Jeremy Frasier Date: Fri, 24 Nov 2023 13:09:54 -0500 Subject: [PATCH] Add a section describing how to install the role This resolves cisagov/skeleton-ansible-role#167. --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 1f806a0..185153f 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,28 @@ None. None. +## Installation ## + +This role can be installed via the command: + +```console +ansible-galaxy ansible-galaxy install --role-file path/to/requirements.yml +``` + +where `requirements.yml` looks like: + +```yaml +--- +- name: skeleton + src: https://github.com/cisagov/skeleton-ansible-role +``` + +and may contain other roles as well. + +For more information about installing Ansible roles via a YAML file, +please see [the `ansible-galaxy` +documentation](https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#installing-multiple-roles-from-a-file). + ## Example Playbook ## Here's how to use it in a playbook: