From 12de0a96d8a24bf3868e95d7711db8b287b17f21 Mon Sep 17 00:00:00 2001
From: Luke Murphy <lukewm@riseup.net>
Date: Thu, 19 Mar 2020 01:55:49 +0100
Subject: [PATCH] Try to explain API further

---
 README.md | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 3ee2321..c880d8b 100644
--- a/README.md
+++ b/README.md
@@ -18,5 +18,32 @@ $ dokku plugin:install https://github.com/decentral1se/dokku-ansible-playbook.gi
 All files must be placed within the `.ansible` folder of your git repository.
 
 * `requirements.yml`: what role dependencies to download before running your plays.
-* `pre-deploy.yml`: the play to run before the application is deployed.
-* `post-deploy.yml`: the play to run after the application is deployed.
+
+The following hooks are supported (add `.yml` to the hook name in `.ansible`):
+
+* `pre-deploy`
+* `post-deploy`
+* `create-app`
+
+## Example
+
+### .ansible/requirements.yml
+
+```yaml
+---
+- src: dokku_bot.ansible_dokku
+  version: v2020.3.15
+```
+
+### .ansible/create-app.yml
+
+```yaml
+---
+- hosts: all
+  tasks:
+    - name: Create foobar group
+      group:
+        name: foobar
+        system: true
+        state: present
+```