From 22dabf43004a4c0bbf27cbfedee8fa5e26bd6c82 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Arne=20J=C3=B8rgensen?= <arne@arnested.dk>
Date: Tue, 15 Jun 2021 16:35:40 +0200
Subject: [PATCH] Mention the GitHub Action in the docs (#174)

---
 README.md               | 28 ++++++++++++++++++++++++++++
 docs/getting-started.md | 30 +++++++++++++++++++++++++++++-
 2 files changed, 57 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 852badd5..e0adaefe 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,34 @@ You may then run send notifications using the shoutrrr executable:
 $ shoutrrr send [OPTIONS] <URL> <Message [...]>
 ```
 
+### From a GitHub Actions workflow
+
+You can also use Shoutrrr from a GitHub Actions workflow.
+
+See this example and the [action on GitHub
+Marketplace](https://github.com/marketplace/actions/shoutrrr-action):
+
+```yaml
+name: Deploy
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Some other steps needed for deploying
+        run: ...
+      - name: Shoutrrr
+        uses: containrrr/shoutrrr-action@v1
+        with:
+          url: ${{ secrets.SHOUTRRR_URL }}
+          title: Deployed ${{ github.sha }}
+          message: See changes at ${{ github.event.compare }}.
+```
+
 ## Documentation
 For additional details, visit the [full documentation](https://containrrr.dev/shoutrrr). 
 
diff --git a/docs/getting-started.md b/docs/getting-started.md
index bc89b6ee..51e33719 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -118,4 +118,32 @@ The target url for the notifications generated, see [overview](./services/overvi
 
 | Flags         | Env.           | Default | Required |
 | ------------- | -------------- | ------- | -------- |
-| `--url`, `-u` | `SHOUTRRR_URL` | N/A     | ✅       |
\ No newline at end of file
+| `--url`, `-u` | `SHOUTRRR_URL` | N/A     | ✅       |
+
+## From a GitHub Actions workflow
+
+You can also use Shoutrrr from a GitHub Actions workflow.
+
+See this example and the [action on GitHub
+Marketplace](https://github.com/marketplace/actions/shoutrrr-action):
+
+```yaml
+name: Deploy
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Some other steps needed for deploying
+        run: ...
+      - name: Shoutrrr
+        uses: containrrr/shoutrrr-action@v1
+        with:
+          url: ${{ secrets.SHOUTRRR_URL }}
+          title: Deployed ${{ github.sha }}
+          message: See changes at ${{ github.event.compare }}.
+```