From 4bab19d289237fafd60ce64ebd83082fa5b61cf6 Mon Sep 17 00:00:00 2001
From: Tyler Perkins <45907232+Clortox@users.noreply.github.com>
Date: Fri, 16 Dec 2022 20:12:40 -0500
Subject: [PATCH] Add Documentation (#7)

* Add Dockerfile and main.sh

* Add base settings for now

* Add drone

* Fix typo in alpine name

* Add ntfy service to drone

* Update dockerfile

* Fix entry point in Dockerfile

* Update README with options
---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/README.md b/README.md
index f9dbf74..5b38f7f 100644
--- a/README.md
+++ b/README.md
@@ -2,5 +2,44 @@
 
 A [Drone](https://drone.io) plugin for ntfy.
 
+## Example
 
+The following is an example pipeline where we only send a notification
+
+```yaml
+steps:
+  - name:
+    image: clortox/drone-ntfy
+    settings:
+      URL: https://ntfy.clortox.com
+      USERNAME: drone
+      PASSWORD:
+        from_secret: ntfy_password
+      TOPIC: drone-builds
+      MESSAGE: Drone build done!
+      CLICK: https://drone.clortox.com/tyler/drone-ntfy
+      TITLE: Drone (Drone-ntfy)
+```
+
+A living, breathing example of this is in this repository's [drone file](.drone.yml).
+
+## Options
+
+There are several options that you can configure when sending the notification.
+Note that the `ntfy Name` is the name you will use in the settings section of
+your configuration.
+
+| ntfy Name     | Container Environment Variable | Default Value                     | Description                                            |
+| --------      | ------                         | -----                             | -----------                                            |
+| Priority      | PLUGIN_PRIORITY                | N/A                               | Notification Priority                                  |
+| Title         | PLUGIN_TITLE                   | N/A                               | Title of the notification                              |
+| Tags          | PLUGIN_TAGS                    | N/A                               | Emojis on the notification                             |
+| Click         | PLUGIN_CLICK                   | N/A                               | URL to navigate to if the user clicks the notification |
+| Attach (TODO) | PLUGIN_ATTACH                  | N/A                               | URL or localfile to attach                             |
+| Icon (TODO)   | PLUGIN_ICON                    | N/A                               | Icon to display                                        |
+| URL           | PLUGIN_URL                     | ntfy.sh                           | URL to send the notification to                        |
+| Topic         | PLUGIN_TOPIC                   | drone-notifications               | The notification top to send this to                   |
+| Message       | PLUGIN_MESSAGE                 | Pipeline Finished!                | The body of the notification                           |
+| Username      | PLUGIN_USERNAME                | N/A                               | The username to authenticate with                      |
+| Password      | PLUGIN_PASSWORD                | N/A                               | The password to authenticate with                      |