Skip to content

Commit

Permalink
Add a section describing how to install the role
Browse files Browse the repository at this point in the history
This resolves #167.
  • Loading branch information
jsf9k committed Nov 24, 2023
1 parent 1666745 commit 3cdb9f2
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,28 @@ None.

None.

## Installation ##

This role can be installed via the command

```bash
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 multiple roles.
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:
Expand Down

0 comments on commit 3cdb9f2

Please sign in to comment.