Skip to content

Commit 8e24edb

Browse files
committed
Docs: fix various links
1 parent c6283f0 commit 8e24edb

File tree

2 files changed

+21
-12
lines changed

2 files changed

+21
-12
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
This projects adheres to [Keep a CHANGELOG](http://keepachangelog.com/) and uses [Semantic Versioning](http://semver.org/).
5+
This projects adheres to [Keep a CHANGELOG](https://keepachangelog.com/) and uses [Semantic Versioning](https://semver.org/).
66

77

88
## [Unreleased]

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@
22

33
<div aria-hidden="true">
44

5-
[![Latest Stable Version](https://poser.pugx.org/phpcsstandards/phpcsdevtools/v/stable)](https://packagist.org/packages/phpcsstandards/phpcsdevtools)
6-
[![Release Date of the Latest Version](https://img.shields.io/github/release-date/PHPCSStandards/PHPCSDevTools.svg?maxAge=1800)](https://github.com/PHPCSStandards/PHPCSDevTools/releases)
5+
[![Latest Stable Version](https://img.shields.io/packagist/v/phpcsstandards/phpcsdevtools?label=stable)][phpcsdevtools-packagist]
6+
[![Release Date of the Latest Version](https://img.shields.io/github/release-date/PHPCSStandards/PHPCSDevTools.svg?maxAge=1800)][phpcsdevtools-releases]
77
[![Changelog](https://img.shields.io/github/v/release/PHPCSStandards/PHPCSDevTools?label=Changelog&sort=semver)](https://github.com/PHPCSStandards/PHPCSDevTools/blob/stable/CHANGELOG.md)
88
:construction:
99
[![Latest Unstable Version](https://img.shields.io/badge/unstable-dev--develop-e68718.svg?maxAge=2419200)](https://packagist.org/packages/phpcsstandards/phpcsdevtools#dev-develop)
1010
[![Last Commit to Unstable](https://img.shields.io/github/last-commit/PHPCSStandards/PHPCSDevTools/develop.svg)](https://github.com/PHPCSStandards/PHPCSDevTools/commits/develop)
1111

12-
[![Minimum PHP Version](https://img.shields.io/packagist/php-v/phpcsstandards/phpcsdevtools.svg?maxAge=3600)](https://packagist.org/packages/phpcsstandards/phpcsdevtools)
13-
[![Build Status CS](https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/cs.yml/badge.svg)](https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/cs.yml)
14-
[![Build Status Test](https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/test.yml/badge.svg)](https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/test.yml)
12+
[![Minimum PHP Version](https://img.shields.io/packagist/dependency-v/phpcsstandards/phpcsdevtools/php.svg)][phpcsdevtools-packagist]
13+
[![Build Status CS](https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/cs.yml/badge.svg)][gha-qa-results]
14+
[![Build Status Test](https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/test.yml/badge.svg)][gha-test-results]
1515
[![Tested on PHP 5.4 to nightly](https://img.shields.io/badge/tested%20on-PHP%205.4%20|%205.5%20|%205.6%20|%207.0%20|%207.1%20|%207.2%20|%207.3%20|%207.4%20|%208.0%20|%208.1%20|%208.2%20|%208.3%20|%208.4%20|%20nightly-brightgreen.svg?maxAge=2419200)](https://github.com/PHPCSStandards/PHPCSDevTools/actions?query=workflow%3ATest)
1616

17-
[![License: LGPLv3](https://poser.pugx.org/phpcsstandards/phpcsdevtools/license)](https://github.com/PHPCSStandards/PHPCSDevTools/blob/stable/LICENSE)
17+
[![License: LGPLv3](https://img.shields.io/github/license/PHPCSStandards/PHPCSDevTools)](https://github.com/PHPCSStandards/PHPCSDevTools/blob/stable/LICENSE)
1818
![Awesome](https://img.shields.io/badge/awesome%3F-yes!-brightgreen.svg)
1919

2020
</div>
2121

22-
This is a set of tools to assist developers of sniffs for [PHP CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer).
22+
This is a set of tools to assist developers of sniffs for [PHP CodeSniffer][phpcs-gh].
2323

2424
* [Installation](#installation)
2525
+ [Composer Project-based Installation](#composer-project-based-installation)
@@ -56,9 +56,9 @@ Composer will automatically install dependencies and register the PHPCSDebug sta
5656

5757
### Stand-alone Installation
5858

59-
* Install [PHP CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer) via [your preferred method](https://github.com/PHPCSStandards/PHP_CodeSniffer#installation).
59+
* Install [PHP CodeSniffer][phpcs-gh] via [your preferred method][phpcs-gh-install].
6060
* Register the path to PHPCS in your system `$PATH` environment variable to make the `phpcs` command available from anywhere in your file system.
61-
* Download the [latest PHPCSDevTools release](https://github.com/PHPCSStandards/PHPCSDevTools/releases) and unzip/untar it into an arbitrary directory.
61+
* Download the [latest PHPCSDevTools release][phpcsdevtools-releases] and unzip/untar it into an arbitrary directory.
6262
You can also choose to clone this repository using git.
6363
* Add the path to the directory in which you placed your copy of the PHPCSDevTools repo to the PHP CodeSniffer configuration using the below command:
6464
```bash
@@ -175,7 +175,7 @@ PHPCS itself can also display similar information using the `-vv` or `-vvv` verb
175175

176176
### Documentation XSD Validation
177177

178-
This project contains an [XML Schema Definition (XSD)](https://www.w3.org/standards/xml/schema) to allow for validation PHPCS documentation XML files. Following the XSD will make sure your documentation can be correctly displayed when using the PHPCS `--generator` option.
178+
This project contains an [XML Schema Definition (XSD)](https://www.w3.org/TR/xmlschema11-1/) to allow for validation PHPCS documentation XML files. Following the XSD will make sure your documentation can be correctly displayed when using the PHPCS `--generator` option.
179179

180180
In order to use it, you'll need to add the schema related attributes to the `documentation` element of the sniff documentation file, like so:
181181

@@ -234,4 +234,13 @@ If unsure whether the changes you are proposing would be welcome, open an issue
234234

235235
## License
236236

237-
This code is released under the [GNU Lesser General Public License (LGPLv3)](http://www.gnu.org/copyleft/lesser.html).
237+
This code is released under the [GNU Lesser General Public License (LGPLv3)](LICENSE).
238+
239+
240+
[phpcsdevtools-packagist]: https://packagist.org/packages/phpcsstandards/phpcsdevtools
241+
[phpcsdevtools-releases]: https://github.com/PHPCSStandards/PHPCSDevTools/releases
242+
[gha-qa-results]: https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/cs.yml
243+
[gha-test-results]: https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/test.yml
244+
245+
[phpcs-gh]: https://github.com/PHPCSStandards/PHP_CodeSniffer
246+
[phpcs-gh-install]: https://github.com/PHPCSStandards/PHP_CodeSniffer#installation

0 commit comments

Comments
 (0)