Skip to content

Commit 74f2025

Browse files
committed
Add a section describing how to install the role
This resolves cisagov/skeleton-ansible-role#167.
1 parent 1666745 commit 74f2025

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,28 @@ None.
3030

3131
None.
3232

33+
## Installation ##
34+
35+
This role can be installed via the command:
36+
37+
```console
38+
ansible-galaxy ansible-galaxy install --role-file path/to/requirements.yml
39+
```
40+
41+
where `requirements.yml` looks like:
42+
43+
```yaml
44+
---
45+
- name: skeleton
46+
src: https://github.com/cisagov/skeleton-ansible-role
47+
```
48+
49+
and may contain other roles as well.
50+
51+
For more information about installing Ansible roles via a YAML file,
52+
please see [the `ansible-galaxy`
53+
documentation](https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#installing-multiple-roles-from-a-file).
54+
3355
## Example Playbook ##
3456

3557
Here's how to use it in a playbook:

0 commit comments

Comments
 (0)