From d2e5000e2f420a7cb50f5a1c3fb0a6d194b9046a Mon Sep 17 00:00:00 2001
From: Shane <6071159+smashedr@users.noreply.github.com>
Date: Wed, 25 Sep 2024 19:21:14 -0700
Subject: [PATCH] Update README.md :book:

---
 .github/workflows/test.yaml |  8 ++++----
 README.md                   | 10 ++++++----
 2 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
index f78ec2b..5e9428d 100644
--- a/.github/workflows/test.yaml
+++ b/.github/workflows/test.yaml
@@ -2,11 +2,11 @@ name: "Test"
 
 on:
   workflow_dispatch:
+  release:
+    types: ["published"]
   push:
-    branches:
-      - "**"
-    tags:
-      - "**"
+    branches: ["**"]
+    tags: ["**"]
 
 jobs:
   test:
diff --git a/README.md b/README.md
index 0050a9d..3ae0cf9 100644
--- a/README.md
+++ b/README.md
@@ -32,16 +32,18 @@ Note: You must provide either a `url` or `host`.
 
 If providing a `host` the `url` is created from `host`/`owner`/`repo` using either provided values or source repository values.
 
+Example workflow file: `.github/workflows/mirror.yaml`
+
 ```yaml
 name: 'Mirror'
 
 on:
     workflow_dispatch:
+    release:
+        types: ['published']
     push:
-        branches:
-            - '**'
-        tags:
-            - '**'
+        branches: ['**']
+        tags: ['**']
 
 jobs:
     mirror: