README.md.jinja2

# Ansible Collection - quera.github

{{ doc.short_description }}

**Note:** Do not modify README.md directly.
It is auto-generated by `python generate_readme` in `readme_src` folder.

## Installation

### Install the `quera.github` collection from Github

```shell
ansible-galaxy collection install git+https://github.com/QueraTeam/ansible-github.git
```

### Install the `install_from_github` module as a local custom module

Alternatively, you may manually install the `install_from_github` module itself as a [local custom module](https://docs.ansible.com/ansible/latest/dev_guide/developing_locally.html) instead of installing the module through the `quera.github` Ansible collection. However, it is recommended to use `quera.github` collection unless you have a good reason not to. Here are the commands to install the `install_from_github` module as a local custom module:

```shell
# Create the user custom module directory
mkdir -p ~/.ansible/plugins/modules

# Install the install_from_github module into the user custom module directory
curl -o ~/.ansible/plugins/modules/install_from_github.py https://raw.githubusercontent.com/QueraTeam/ansible-github/main/plugins/modules/install_from_github.py
```

## Ansible Module - quera.github.install_from_github

{% for description_paragraph in doc.description %}
{{ description_paragraph }}
{% endfor %}


### Options

{{ options_md_table }}


### Examples

```yaml
{{ examples }}
```