Skip to content

Commit 7451d32

Browse files
chore: update README.md with badge enhancements and section reorganization
1 parent bbc7178 commit 7451d32

1 file changed

Lines changed: 21 additions & 11 deletions

File tree

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,19 @@
55
# TYPO3 extension `xima_typo3_internal_news`
66

77
[![Latest Stable Version](https://typo3-badges.dev/badge/xima_typo3_internal_news/version/shields.svg)](https://extensions.typo3.org/extension/xima_typo3_internal_news)
8-
[![TYPO3 12](https://img.shields.io/badge/TYPO3-12-orange.svg)](https://get.typo3.org/version/12)
9-
[![TYPO3 13](https://img.shields.io/badge/TYPO3-13-orange.svg)](https://get.typo3.org/version/13)
10-
[![Total Downloads](https://poser.pugx.org/xima/xima-typo3-internal-news/d/total)](https://packagist.org/packages/xima/xima-typo3-internal-news)
8+
[![Supported TYPO3 versions](https://typo3-badges.dev/badge/xima_typo3_internal_news/typo3/shields.svg)](https://extensions.typo3.org/extension/xima_typo3_internal_news)
9+
[![Coverage](https://img.shields.io/coverallsCoverage/github/xima-media/xima-typo3-internal-news?logo=coveralls)](https://coveralls.io/github/xima-media/xima-typo3-internal-news)
10+
[![CGL](https://img.shields.io/github/actions/workflow/status/xima-media/xima-typo3-internal-news/cgl.yml?label=cgl&logo=github)](https://github.com/xima-media/xima-typo3-internal-news/actions/workflows/cgl.yml)
11+
[![Tests](https://img.shields.io/github/actions/workflow/status/xima-media/xima-typo3-internal-news/tests.yml?label=tests&logo=github)](https://github.com/xima-media/xima-typo3-internal-news/actions/workflows/tests.yml)
12+
[![License](https://poser.pugx.org/konradmichalik/xima-typo3-internal-news/license)](LICENSE.md)
1113

1214
</div>
1315

1416
This extension provides an internal news system with custom access and notification capabilities for the TYPO3 backend, e.g. to inform editors about new features and changes in the cms.
1517

1618
![Record](./Documentation/Images/screenrecord.gif)
1719

18-
## Features
20+
## Features
1921

2022
* Create, edit and delete internal news records
2123
* Define custom dates within news to notify backend users for specific events, e.g. next maintanance
@@ -24,11 +26,13 @@ This extension provides an internal news system with custom access and notificat
2426
* Dashboard widget for news overview
2527
* Toolbar item for quick access to latest news
2628

27-
## Requirements
2829

29-
* TYPO3 >= 12.4 & PHP 8.1+
30+
## 🔥 Installation
3031

31-
## Installation
32+
### Requirements
33+
34+
* TYPO3 >= 12.4
35+
* PHP 8.1+
3236

3337
### Composer
3438

@@ -42,7 +46,7 @@ composer require xima/xima-typo3-internal-news
4246

4347
Download the zip file from [TYPO3 extension repository (TER)](https://extensions.typo3.org/extension/xima_typo3_internal_news).
4448

45-
## Usage
49+
## 📊 Usage
4650

4751
Add the dashboard widget "Internal News" to your dashboard to get an overview of all news.
4852

@@ -66,13 +70,19 @@ The notification hint will be displayed by default within a time slot 6 hours be
6670

6771
![Notification](./Documentation/Images/notification.png)
6872

69-
## License
73+
## 🧑‍💻 Contributing
7074

71-
This project is licensed
72-
under [GNU General Public License 2.0 (or later)](LICENSE.md).
75+
Please have a look at [`CONTRIBUTING.md`](CONTRIBUTING.md).
76+
77+
## 💎 Credits
7378

7479
News icon by Rock Zombie from <a href="https://thenounproject.com/icon/news-3141439/" target="_blank" title="Icon">
7580
Noun Project</a> (CC BY 3.0)
7681

7782
Date icon by Yudhi Restu Pebriyanto from <a href="https://thenounproject.com/icon/date-7203889/" target="_blank" title="Icon">
7883
Noun Project</a> (CC BY 3.0)
84+
85+
## ⭐ License
86+
87+
This project is licensed
88+
under [GNU General Public License 2.0 (or later)](LICENSE.md).

0 commit comments

Comments
 (0)