From c506517317b554651c337eb7e3986530685bb89a Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Sat, 28 Mar 2020 16:55:50 +0100 Subject: [PATCH] Add usage documentation --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 3be1e5f..1dd7d70 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,20 @@ Ansible libraries for manging Gandi resources. +## Usage + +Include an entry in your `requirements.yml` like so. + +```yaml +- src: https://git.autonomic.zone/autonomic-cooperative/autonomic.gandi + version: 0.0.1 + name: autonomic.gandi +``` + +See the [releases](https://git.autonomic.zone/autonomic-cooperative/autonomic.gandi/releases) for which is the latest version. + +Then make sure to download the role with `ansible-galaxy install -r requirements.yml`. + ## Roadmap - [ ] DNS entries