ansible-antidote-role/README.md

# Ansible-Antidote-Role

A brief description of the role goes here.

## Requirements

Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.

## Role Variables

```yaml
# antidote is installed per user so you need to specify the users to install it for
users:
  - username: # The username of the user to install Antidote for
    antidote_plugins:
      - name: # The name of the library (e.g. oh-my-zsh or prezto) must be unique
        kind:
        branch:
        path:
```

## Dependencies

A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.

## Example Playbook

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

    - hosts: servers
      roles:
         - { role: username.rolename, x: 42 }

## License

BSD

## Author Information

An optional section for the role authors to include contact information, or a website (HTML is not allowed).