From 1a18dedf6369aeeadab57fcbd081d51f68ba1bde Mon Sep 17 00:00:00 2001
From: Pim Kunis <pim@kunis.nl>
Date: Wed, 14 Jun 2023 13:07:18 +0200
Subject: [PATCH] Add readme

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..83f7a6a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# concourse-apprise-notifier
+
+[Concourse](https://concourse-ci.org/) resource type to send [Apprise](https://github.com/caronc/apprise) notifications.
+Code based on [github.com/mockersf/concourse-slack-notifier](https://github.com/mockersf/concourse-slack-notifier).
+Currently, only the [persistent storage solution](https://github.com/caronc/apprise-api#persistent-storage-solution) is supported (because that's what I use).
+
+## Installing
+
+Add the following to our Concourse pipeline:
+```yaml
+resource_types:
+- name: apprise
+  type: registry-image
+  source:
+    repository: git.pim.kunis.nl/pim/concourse-apprise-notifier
+```
+
+## Source Configuration
+
+- `host`: _Required_. Base Apprise host URL.
+- `key`: _Required_. Notification key.
+
+## Behaviour
+
+`check`: No operation.
+
+`in`: No operation.
+
+`out`: Send a message via Apprise.
+
+### Parameters
+
+Check the official [Apprise documation](https://github.com/caronc/apprise-api#persistent-storage-solution) for more information.
+
+- `body`: _Required_. The body of the notification.
+- `title`: The title of the notification.
+- `type`: The type of the notification.
+- `tag`: The tags of the notification.
+- `format`: The format of the notification.