From 27e9acb517b59220bb9c33e744b7ab27f5deaeb0 Mon Sep 17 00:00:00 2001
From: SethCohen <47002293+SethCohen@users.noreply.github.com>
Date: Wed, 24 Aug 2022 02:26:40 -0400
Subject: [PATCH] chore: updated README.md

---
 README.md | 35 +++++++++++++++++------------------
 1 file changed, 17 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index c4b79de..c988e03 100644
--- a/README.md
+++ b/README.md
@@ -2,19 +2,8 @@
 A GitHub action that parses a GitHub release and posts it to a Discord channel as a stylized Discord webhook.
 
 ---
-
-## Setup Instructions
-1. Open your **Server Settings** and head into the **Integrations** tab:
-2. Click the "**Create Webhook**" button to create a new webhook!
-   ![](https://support.discord.com/hc/article_attachments/1500000463501/Screen_Shot_2020-12-15_at_4.41.53_PM.png)
-   ![](https://support.discord.com/hc/article_attachments/360101553853/Screen_Shot_2020-12-15_at_4.51.38_PM.png)
-3. Copy the webhook url
-4. Create a new Github repository secret called WEBHOOK_URL and paste the webhook url into it.
-   ![](https://i.imgur.com/hAaNOds.png)
-5. Save the secret.
-6. Add the secret to your action configuration.
-
-And you're done!
+## Output
+![output](https://i.imgur.com/Zf3TXtb.png)
 
 ## Configuration
 
@@ -25,12 +14,9 @@ And you're done!
 | username   | ❌       | "Release Changelog"                                                                                            | String username for webhook.               |
 | avatar_url | ❌       | ["Profile Picture"](https://cdn.discordapp.com/avatars/487431320314576937/bd64361e4ba6313d561d54e78c9e7171.png) | String url to webhook avatar picture.      |
 
-
-## Output
-![output](https://i.imgur.com/Zf3TXtb.png)
-
 ## Example Usage
 
+`.github/workflows/github-release-to-discord.yml`
 ```yaml
 on:
   release:
@@ -49,4 +35,17 @@ jobs:
           color: "2105893"
           username: "Release Changelog"
           avatar_url: "https://cdn.discordapp.com/avatars/487431320314576937/bd64361e4ba6313d561d54e78c9e7171.png"
-```
\ No newline at end of file
+```
+
+## Setup Instructions
+1. Open your **Server Settings** and head into the **Integrations** tab:
+2. Click the "**Create Webhook**" button to create a new webhook!
+   ![](https://support.discord.com/hc/article_attachments/1500000463501/Screen_Shot_2020-12-15_at_4.41.53_PM.png)
+   ![](https://support.discord.com/hc/article_attachments/360101553853/Screen_Shot_2020-12-15_at_4.51.38_PM.png)
+3. Copy the webhook url
+4. Create a new Github repository secret called WEBHOOK_URL and paste the webhook url into it.
+   ![](https://i.imgur.com/hAaNOds.png)
+5. Save the secret.
+6. Add the secret to your action configuration.
+
+And you're done! Whenever you create a new release, the workflow should run and, if properly setup, post to your specified Discord channel.