docs: add documentation for gotify service

README.md

@@ -54,6 +54,7 @@ platforms.
 
 - *Discord*
 - *Email*
+- *Gotify*
 - *Line*
 - *Mastodon*
 - *Mattermost*
@@ -78,7 +79,7 @@ brew install kha7iq/tap/pingme
 ## Linux Binary
 
 ```bash
-wget -q https://github.com/kha7iq/pingme/releases/download/v0.1.6/pingme_Linux_x86_64.tar.gz
+wget -q https://github.com/kha7iq/pingme/releases/download/v0.2.3/pingme_Linux_x86_64.tar.gz
 tar -xf pingme_Linux_x86_64.tar.gz
 chmod +x pingme
 sudo mv pingme /usr/local/bin/pingme
@@ -153,7 +154,8 @@ DESCRIPTION:
    PingMe is a CLI tool which provides the ability to send messages or alerts to multiple
    messaging platforms and also email, everything is configurable via environment
    variables and command line switches.Currently supported platforms include Slack, Telegram,
-   RocketChat, Discord, Pushover, Mattermost, Pushbullet, Microsoft Teams, Twillio, Mastodon and email address.
+   RocketChat, Discord, Pushover, Mattermost, Pushbullet, Microsoft Teams, Twillio, Mastodon,
+   email address, Line, Gotify and Wechat.
 
 COMMANDS:
    telegram    Send message to telegram
@@ -170,6 +172,7 @@ COMMANDS:
    mastodon    Set status message for mastodon
    line        Send message to line messenger
    wechat      Send message to wechat official account
+   gotify      Send push notification to gotify server
    help, h     Shows a list of commands or help for one command
 
 GLOBAL OPTIONS:

docs/home.md

@@ -50,15 +50,18 @@ platforms.
 
 - *Discord*
 - *Email*
-- *Microsoft Teams*
+- *Gotify*
+- *Line*
+- *Mastodon*
 - *Mattermost*
-- *Pushover*
+- *Microsoft Teams*
 - *Pushbullet*
+- *Pushover*
 - *RocketChat*
 - *Slack*
 - *Telegram*
 - *Twillio*
-- *Line Messenger*
+- *Zulip*
 - *Wechat*
 
 ## Demo

docs/services.md

@@ -48,11 +48,54 @@ jobs:
 
 |          Variables         | Default Value      |
 | -------------------------- | :----------------: |
-| TELEGRAM_MSG_TITLE         | ""                 |  
+| TELEGRAM_TITLE         | ""                 |  
 | TELEGRAM_TOKEN             | ""                 |
 | TELEGRAM_CHANNELS          | ""                 |
 | TELEGRAM_MESSAGE           | ""                 |
-| TELEGRAM_MSG_TITLE         | ""                 |  
+
+## Gotify
+
+With gotify you can send push messages to any instance of Gotify server.
+
+```bash
+pingme gotify  --url 'https://example.com' --token 'tokenabc' --title 'some title'  --msg 'some message' --priority 5
+```
+
+- GitHub Action
+
+```yaml
+on: [push]
+
+jobs:
+  pingme-job:
+    runs-on: ubuntu-latest
+    name: PingMe
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Ping me On
+        uses: kha7iq/pingme-action@v1
+        env:
+          GOTIFY_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
+          GOTIFY_TITLE: 'Reference: ${{ github.ref }}'
+          GOTIFY_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
+        
+        with:
+          # Chose the messaging platform. 
+          # slack / telegram / rocketchat / teams / pushover / discord / email
+          service: gotify
+```
+
+- **Variables**
+
+|          Variables         | Default Value      |
+| -------------------------- | :----------------: |
+| GOTIFY_URL       | ""                 |  
+| GOTIFY_TOKEN             | ""                 |
+| GOTIFY_PRIORITY          | "5"                 |
+| GOTIFY_MESSAGE           | ""                 |
+| GOTIFY_TITLE         | "Server Time"                 |  
 
 ## RocketChat