Skip to content
This repository was archived by the owner on Nov 17, 2018. It is now read-only.

Commit e2f52c7

Browse files
authored
Update README.md
1 parent a17e99a commit e2f52c7

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

README.md

+11-16
Original file line numberDiff line numberDiff line change
@@ -41,31 +41,26 @@ There are a few options you can choose from:
4141
![Standard options in the Discord Webhook config](https://github.com/jammehcow/jenkins-discord/blob/master/.github/usage_02.jpg)
4242
![Advanced tab in the config](https://github.com/jammehcow/jenkins-discord/blob/master/.github/usage_03.jpg)
4343

44-
### Pipeline
44+
## Pipeline
4545

46-
#### Parameters
46+
Discord Notifier supports Jenkins Pipeline. The only required parameter is webhookURL (the URL of the webhook, of course) - but there isn't much point of sending nothing.
4747

48-
##### Required
49-
50-
- webhookURL
51-
- The URL of the webhook (pretty self-explanatory) provided by Discord
52-
53-
##### Optional
54-
55-
The following parameters can be omitted
48+
### Parameters
5649

50+
- webhookURL (required)
51+
- The URL of the webhook (pretty self-explanatory) provided by Discord.
5752
- title
58-
- Title of the message
53+
- The title of the embed.
5954
- link
60-
- If set, the title becomes clickable to this URL
55+
- If set, the title becomes a link to this URL.
6156
- description
62-
- Message text, can be markdown formatted, [Markdown Text 101 (Chat Formatting: Bold, Italic, Underline)](https://support.discordapp.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline-)
57+
- The description of the message (the main chunk of text), can be markdown formatted, [Markdown Text 101 (Chat Formatting: Bold, Italic, Underline)](https://support.discordapp.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline-).
6358
- footer
64-
- Text in footer of the message
59+
- The text in footer of the message.
6560
- successful
66-
- Color the message green for true, red for false
61+
- True makes the left-hand side of the embed green, false sets it to red.
6762

68-
#### Example
63+
### Example
6964

7065
````
7166
pipeline {

0 commit comments

Comments
 (0)