Skip to content

Commit

Permalink
docs: fixes markdown issues in readme and adds image
Browse files Browse the repository at this point in the history
  • Loading branch information
nhevia committed Jan 28, 2021
1 parent b7c5d7f commit e122656
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# discord-styled-releases
*Action that uses a webhook for sending automatic styled Discord messages on new repository releases.*

####Example usage

![alt](https://i.imgur.com/jwo6XsD.png)

### Example usage

Create file `discord-release-msg.yml` under folder `.github/workflows` in your project's root folder:
>.github/workflows/discord-release-msg.yml
Expand All @@ -27,7 +30,7 @@ jobs:
webhook_token: ${{ secrets.DISCORD_WEBHOOK_TOKEN }}
```
####Create a webhook
### Create a webhook
To create a new webhook in discord go to **Channel > Edit > Integrations > Webhooks > New Webhook**
Expand All @@ -36,7 +39,7 @@ Once you have the webhoook URL, you can get the `ID` and the `TOKEN`. They are i
> https://discord.com/api/webhooks/ID/TOKEN


####Adding neccesary secrets
### Adding necessary secrets

This is needed to not expose your `ID/TOKEN` (which would mean anybody can use your webhook)

Expand Down

0 comments on commit e122656

Please sign in to comment.