Skip to content

Commit ab00ee5

Browse files
Added emojis to readme
1 parent 6ec030e commit ab00ee5

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,33 @@
22
This GitHub Action can produce fancy and more meaningful discord messages for your commits.
33
<br>It includes Test results and coverage.
44

5-
## Requirements
5+
## :notebook: Requirements
66
This currently works only for Maven projects.
77
For Test Results and Coverage Reports you will need to use one of the following Maven plugins:
88
* `maven-surefire`
99
* `maven-failsafe`
1010
* `jacoco`
1111

12-
## Inputs
12+
## :mailbox_with_no_mail: Inputs
1313

1414
### `id`
1515
**Required** This is the id of your Discord webhook, if you copy the webhook url, this will be the first part of it.
1616

1717
### `token`
1818
**Required** Now your Discord webhook token, it's the second part of the url.
1919

20-
## Screenshots
20+
## :framed_picture: Screenshots
2121
The standard webhook from GitHub to Discord just dumps the commit messages right into your chat, this is fine but sometimes you just want some extra information. Did the commit introduce any new issues? Did it even compile successfully? That's what this Action is for.<br>
2222

23-
### Standard Webhook
23+
### :spider_web: Standard Webhook
2424
![old webhook](https://raw.githubusercontent.com/baked-libs/discord-webhook/master/assets/old-webhook.png)
2525

26-
### New and improved Webhook
26+
### :star: New and improved Webhook
2727
![tests passed](https://raw.githubusercontent.com/baked-libs/discord-webhook/master/assets/tests-passed.png)
2828
![tests skipped](https://raw.githubusercontent.com/baked-libs/discord-webhook/master/assets/tests-skipped.png)
2929
![tests failed](https://raw.githubusercontent.com/baked-libs/discord-webhook/master/assets/tests-failed.png)
3030

31-
### Changes
31+
### :books: Changes
3232
* Removed the obnoxious author name and image at the top (may be a toggle in the future)
3333
* The branch is now clearly visible "Slimefun4:master" -> "Slimefun4 (master)"
3434
* The repository is now referred to by its full name, including the repository owner
@@ -39,7 +39,7 @@ The standard webhook from GitHub to Discord just dumps the commit messages right
3939
* An estimated test coverage is provided if you use the `jacoco` maven plugin.
4040
* Dynamic embed color changes
4141

42-
#### Dynamic Coloring
42+
#### :art: Dynamic Coloring
4343
The color of the embed changes depending on the compiler and test results. Here's a breakdown:
4444

4545
| Color | Description |
@@ -49,7 +49,7 @@ The color of the embed changes depending on the compiler and test results. Here'
4949
| yellow | The build was successful, no tests failed but some were skipped. |
5050
| green | The build was successful, no tests failed and none were skipped. |
5151

52-
## Example setup
52+
## :scroll: Example setup
5353
To set up this Action, create a new workflow file under `.github/workflows/workflow_name.yml`.
5454

5555
**Important:** Your project must have a `pom.xml` file, this Action only supports Maven at the moment.<br>

0 commit comments

Comments
 (0)