Skip to content

Commit 6d1dcf7

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 38096f4 commit 6d1dcf7

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: PHP Codesniffer
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
@@ -62,9 +63,9 @@ You could also [open an issue here][issue]
6263
This is an active open-source project. We are always open to people who want to
6364
use the code or contribute to it.
6465
65-
We've set up a separate document for our [contribution guidelines](CONTRIBUTING.md).
66+
We've set up a separate document for our [contribution guidelines][contributing-link].
6667
67-
Thank you for being involved! :heart_eyes:
68+
Thank you for being involved! 😍
6869
6970
## Authors & contributors
7071
@@ -78,44 +79,23 @@ check [the contributor's page][contributors].
7879
7980
## License
8081
81-
MIT License
82-
83-
Copyright (c) 2018 Robbert Müller
84-
85-
Permission is hereby granted, free of charge, to any person obtaining a copy
86-
of this software and associated documentation files (the "Software"), to deal
87-
in the Software without restriction, including without limitation the rights
88-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
89-
copies of the Software, and to permit persons to whom the Software is
90-
furnished to do so, subject to the following conditions:
91-
92-
The above copyright notice and this permission notice shall be included in all
93-
copies or substantial portions of the Software.
82+
This project is licensed under the [MIT License](./LICENSE) by [Robbert Müller][mjrider].
9483
95-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
96-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
97-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
98-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
99-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
100-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
101-
SOFTWARE.
102-
103-
[commits]: https://gitlab.com/pipeline-components/php-codesniffer/-/commits/main
84+
[contributing-link]: https://pipeline-components.dev/contributing/
10485
[contributors]: https://gitlab.com/pipeline-components/php-codesniffer/-/graphs/main
105-
[dockerhub]: https://hub.docker.com/r/pipelinecomponents/php-codesniffer
106-
[license-shield]: https://img.shields.io/badge/License-MIT-green.svg
107-
[mjrider]: https://gitlab.com/mjrider
10886
[discord]: https://discord.gg/vhxWFfP
87+
[dockerhub]: https://hub.docker.com/r/pipelinecomponents/php-codesniffer
88+
[frenck]: https://github.com/frenck
89+
[gitlab-repo-shield]: https://img.shields.io/badge/Source-Gitlab-orange.svg?logo=gitlab
10990
[gitlabci-shield]: https://img.shields.io/gitlab/pipeline/pipeline-components/php-codesniffer.svg
11091
[gitlabci]: https://gitlab.com/pipeline-components/php-codesniffer/-/commits/main
92+
[hassio-addons]: https://github.com/hassio-addons
11193
[issue]: https://gitlab.com/pipeline-components/php-codesniffer/issues
112-
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
94+
[license-shield]: https://img.shields.io/badge/License-MIT-green.svg
11395
[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg
96+
[mjrider]: https://gitlab.com/mjrider
11497
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
115-
[pulls-shield]: https://img.shields.io/docker/pulls/pipelinecomponents/php-codesniffer.svg
116-
[releases]: https://gitlab.com/pipeline-components/php-codesniffer/tags
98+
[pulls-shield]: https://img.shields.io/docker/pulls/pipelinecomponents/php-codesniffer.svg?logo=docker
11799
[repository]: https://gitlab.com/pipeline-components/php-codesniffer
118100
[semver]: http://semver.org/spec/v2.0.0.html
119-
120-
[frenck]: https://github.com/frenck
121-
[hassio-addons]: https://github.com/hassio-addons
101+
[size-shield]: https://img.shields.io/docker/image-size/pipelinecomponents/php-codesniffer.svg?logo=docker

0 commit comments

Comments
 (0)