From 0355148dbf76c1fffe7adbd005fe0191e6e526a7 Mon Sep 17 00:00:00 2001
From: Peter Evans <18365890+peter-evans@users.noreply.github.com>
Date: Wed, 9 Jul 2025 08:58:08 +0100
Subject: [PATCH] docs: update readme

Just some minor changes to keep things consistent with the style of my other actions repos
---
 README.md | 30 +++++++++++++-----------------
 1 file changed, 13 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index f452edf..192f98d 100644
--- a/README.md
+++ b/README.md
@@ -10,31 +10,27 @@ A GitHub action to create a repository dispatch event.
 
 In the caller workflow file:
 
-```diff
+```yml
 jobs:
-  your_job_name:
+  Dispatch:
     runs-on: ubuntu-latest
-+    permissions:
-+      contents: write
+    permissions:
+      contents: write
      steps:
-       …
-+       - name: Repository Dispatch
-+         uses: peter-evans/repository-dispatch@v3
-+         with:
-+           event-type: my-event
+       - name: Repository Dispatch
+         uses: peter-evans/repository-dispatch@v3
+         with:
+           event-type: my-event
 ```
 
 In the callee workflow file:
 
-```diff
-name: YourWorkflow
+```yml
+name: MyWorkflow
 
-+on:
-+  repository_dispatch:
-+    types: [my-event]
-
-jobs:
-  …
+on:
+  repository_dispatch:
+    types: [my-event]
 ```
 
 ### Dispatching an event to a remote repository