Ntfy dockerhub docs (#15)

* Update README.md

* Remove todo from completed features

.drone.yml

@@ -15,3 +15,17 @@ steps:
     when:
       branch:
         - main
+  - name: notify
+    image: clortox/drone-ntfy
+    settings:
+      URL: https://ntfy.clortox.com
+      USERNAME: drone
+      PASSWORD:
+        from_secret: ntfy_password
+      TOPIC: drone-builds
+      MESSAGE: Drone-ntfy has finished building!
+      CLICK: https://drone.clortox.com/tyler/drone-ntfy
+      TITLE: Drone (drone-ntfy)
+    when:
+      branch:
+        - main

Dockerfile

@@ -1,5 +1,5 @@
-FROM apline
+FROM alpine
-ADD main.sh /bin/
+COPY main.sh /bin/
 RUN chmod +x /bin/main.sh
-RUN apk -Uuv add curl ca-certificates
+RUN apk -Uuv add curl ca-certificates bash
-ENTRYPOINT /bin/main.sh
+ENTRYPOINT bash /bin/main.sh

README.md

@@ -1,6 +1,49 @@
 # drone-ntfy
 
-A [Drone](https://drone.io) plugin for ntfy.
+[![Build Status](https://drone.clortox.com/api/badges/tyler/drone-ntfy/status.svg?ref=refs/heads/main)](https://drone.clortox.com/tyler/drone-ntfy)
 
+A [Drone](https://drone.io) plugin for [ntfy](https://ntfy.sh).
 
+Find the container on [docker hub](https://hub.docker.com/repository/docker/clortox/drone-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        | PLUGIN_ATTACH                  | N/A                               | URL or localfile to attach                             |
+| Icon          | 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                      |
 

main.sh

@@ -6,7 +6,6 @@ Priority=${PLUGIN_PRIORITY:-}
 Title=${PLUGIN_TITLE:-}
 Tags=${PLUGIN_TAGS:-}
 Click=${PLUGIN_CLICK:-}
-
 Attach=${PLUGIN_ATTACH:-}
 Icon=${PLUGIN_ICON:-}
 
@@ -17,6 +16,10 @@ Message=${PLUGIN_MESSAGE:-Pipeline finished!}
 Username=${PLUGIN_USERNAME:-}
 Password=${PLUGIN_PASSWORD:-}
 
+if [[ ! -z $Username ]] || [[ ! -z $Password ]]; then
+    UParam="-u $Username:$Password"
+fi
+
 if [[ ! -z $Priority ]]; then
     Priority="-H Priority:$Priority"
 fi
@@ -33,5 +36,13 @@ if [[ ! -z $Click ]]; then
     Click="-H Click:$Click"
 fi
 
-curl $Priority $Title $Tags $Click -u $Username:$Password -d "$Message" $URL/$Topic
+if [[ ! -z $Attach ]]; then
-#echo curl $Priority $Title $Tags $Click -u $Username:$Password -d "$Message" $URL/$Topic
+    Attach="-H Attach:$Attach"
+fi
+
+if [[ ! -z $Icon ]]; then
+    Icon="-H Icon:$Icon"
+fi
+
+curl $Priority $Title $Tags $Click $Attach $Icon $UParam -d "$Message" $URL/$Topic
+#curl $Priority $Title $Tags $Click $Attach $Icon $UParam -d "$Message" $URL/$Topic