Skip to content

Commit c93ceab

Browse files
authored
Beautify readme (#11)
* 📝 add emojis for headlines * 📝 use collapse blocks for templates
1 parent 880fbae commit c93ceab

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ jobs:
1919
...
2020
```
2121
22-
## Example Configurations
22+
## Example Configurations 🔧
2323
2424
In the next sections you can find examples for the template workflows. For more information, please take a look at the templates.
2525
2626
### Release Drafter
2727
28-
The action can be used to draft automatically a new release.
28+
<details>
29+
<summary>The action can be used to draft automatically a new release.</summary>
2930
3031
```yml
3132
name: Release Drafter
@@ -39,10 +40,12 @@ jobs:
3940
update_release_draft:
4041
uses: Staffbase/gha-workflows/.github/workflows/[email protected]
4142
```
43+
</details>
4244
4345
### Stale
4446
45-
The action can be used to close old pull requests or issues automatically after a few days.
47+
<details>
48+
<summary>The action can be used to close old pull requests or issues automatically after a few days.</summary>
4649
4750
```yml
4851
name: Stale PRs
@@ -55,10 +58,12 @@ jobs:
5558
stale:
5659
uses: Staffbase/gha-workflows/.github/workflows/[email protected]
5760
```
61+
</details>
5862
5963
### Yamllint
6064
61-
The action can be used to check yaml files for formatting.
65+
<details>
66+
<summary>The action can be used to check yaml files for formatting.</summary>
6267
6368
```yml
6469
name: YAMLlint
@@ -74,16 +79,17 @@ jobs:
7479
yamllint:
7580
uses: Staffbase/gha-workflows/.github/workflows/[email protected]
7681
```
82+
</details>
7783
78-
## Release
84+
## Release 🔖
7985
8086
To create a new release just use [this page][2] and publish the draft release.
8187
82-
## Contributing
88+
## Contributing 👥
8389
8490
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
8591
86-
## License
92+
## License 📄
8793
8894
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
8995

0 commit comments

Comments
 (0)