# Ansible Collection - {{ namespace }}.{{ collection_name }}

An Ansible collection template.

## Installation

This collection is published to [Ansible Galaxy](https://galaxy.ansible.com). It
can be installed using the Ansible Galaxy CLI:

```bash
ansible-galaxy collection install {{ namespace }}.{{ collection_name }}
```

It is also possible to specify this collection in the `requirements.yaml` (or
`requirements.yml`) file:

```yaml
---
collections:
  - name: {{ namespace }}.{{ collection_name }}
    version: "vX.Y.Z"   # optionally specify version
```

And use the Ansible Galaxy CLI to install the definitions from the requirements
file:

```bash
ansible-galaxy install -r requirements.yaml
```

Alternatively, the collection can be obtained from the Git repository. This may
be desirable to get the latest development version. The following
`requirements.yaml` entry, can be used to download directly from Git:

```yaml
---
collections:
  - name: https://codeberg.org/{{ namespace }}/ansible-collection-{{ namespace }}-{{ collection_name }}
    version: main
    type: git
```

For more information, see the [Installing
collections](https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html)
section of the Ansible documentation.

## License

[The Unlicense](./LICENSE)

## Author Information

lingling ([Codeberg][Codeberg], [GitHub][GitHub])

[Codeberg]: https://codeberg.org/lingling
[GitHub]: https://github.com/lingling9000