Skip to content

Commit fbcceb4

Browse files
committed
Change README to be cleaner
- Fix broken contributing link - Replace license text with link to license file - Sort links alphabetically - Add Link to repository (for on Docker Hub) - Add shield for Docker image size s to enhance links, shields, and formatting Key changes include replacing inline links with reference-style links, adding missing badges, updating outdated links, and reformatting sections for a standardized presentation. It also adjusts license and contribution details for better readability.
1 parent 65d0972 commit fbcceb4

File tree

1 file changed

+14
-34
lines changed

1 file changed

+14
-34
lines changed

README.md

Lines changed: 14 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Pipeline Components: PHPlinter
22

3+
[![][gitlab-repo-shield]][repository]
34
![Project Stage][project-stage-shield]
45
![Project Maintenance][maintenance-shield]
56
[![License][license-shield]](LICENSE)
6-
77
[![GitLab CI][gitlabci-shield]][gitlabci]
88

99
## Docker status
1010

11+
[![Image Size][size-shield]][dockerhub]
1112
[![Docker Pulls][pulls-shield]][dockerhub]
1213

1314
## Usage
@@ -42,9 +43,9 @@ You could also [open an issue here][issue]
4243
This is an active open-source project. We are always open to people who want to
4344
use the code or contribute to it.
4445
45-
We've set up a separate document for our [contribution guidelines](CONTRIBUTING.md).
46+
We've set up a separate document for our [contribution guidelines][contributing-link].
4647
47-
Thank you for being involved! :heart_eyes:
48+
Thank you for being involved! 😍
4849
4950
## Authors & contributors
5051
@@ -58,44 +59,23 @@ check [the contributor's page][contributors].
5859
5960
## License
6061
61-
MIT License
62-
63-
Copyright (c) 2018 Robbert Müller
64-
65-
Permission is hereby granted, free of charge, to any person obtaining a copy
66-
of this software and associated documentation files (the "Software"), to deal
67-
in the Software without restriction, including without limitation the rights
68-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
69-
copies of the Software, and to permit persons to whom the Software is
70-
furnished to do so, subject to the following conditions:
71-
72-
The above copyright notice and this permission notice shall be included in all
73-
copies or substantial portions of the Software.
62+
This project is licensed under the [MIT License](./LICENSE) by [Robbert Müller][mjrider].
7463
75-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
76-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
77-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
78-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
79-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
80-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
81-
SOFTWARE.
82-
83-
[commits]: https://gitlab.com/pipeline-components/php-linter/-/commits/main
64+
[contributing-link]: https://pipeline-components.dev/contributing/
8465
[contributors]: https://gitlab.com/pipeline-components/php-linter/-/graphs/main
85-
[dockerhub]: https://hub.docker.com/r/pipelinecomponents/php-linter
86-
[license-shield]: https://img.shields.io/badge/License-MIT-green.svg
87-
[mjrider]: https://gitlab.com/mjrider
8866
[discord]: https://discord.gg/vhxWFfP
67+
[dockerhub]: https://hub.docker.com/r/pipelinecomponents/php-linter
68+
[frenck]: https://github.com/frenck
69+
[gitlab-repo-shield]: https://img.shields.io/badge/Source-Gitlab-orange.svg?logo=gitlab
8970
[gitlabci-shield]: https://img.shields.io/gitlab/pipeline/pipeline-components/php-linter.svg
9071
[gitlabci]: https://gitlab.com/pipeline-components/php-linter/-/commits/main
72+
[hassio-addons]: https://github.com/hassio-addons
9173
[issue]: https://gitlab.com/pipeline-components/php-linter/issues
92-
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
74+
[license-shield]: https://img.shields.io/badge/License-MIT-green.svg
9375
[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg
76+
[mjrider]: https://gitlab.com/mjrider
9477
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
95-
[pulls-shield]: https://img.shields.io/docker/pulls/pipelinecomponents/php-linter.svg
96-
[releases]: https://gitlab.com/pipeline-components/php-linter/tags
78+
[pulls-shield]: https://img.shields.io/docker/pulls/pipelinecomponents/php-linter.svg?logo=docker
9779
[repository]: https://gitlab.com/pipeline-components/php-linter
9880
[semver]: http://semver.org/spec/v2.0.0.html
99-
100-
[frenck]: https://github.com/frenck
101-
[hassio-addons]: https://github.com/hassio-addons
81+
[size-shield]: https://img.shields.io/docker/image-size/pipelinecomponents/php-linter.svg?logo=docker

0 commit comments

Comments
 (0)