Skip to content

Commit 1120560

Browse files
committed
README: add info about use of other projects
... as well as funding info. Includes excluding one URL from the "dead URL" markdown check as it consistently refuses to validate, even though the URL is valid and correct.
1 parent 7d3ffdb commit 1120560

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

.remarkrc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@
88
["remark-lint-linebreak-style", "unix"],
99
["remark-lint-link-title-style", "\""],
1010
["remark-lint-ordered-list-marker-style", "."],
11-
"remark-lint-no-dead-urls",
11+
[
12+
"remark-lint-no-dead-urls",
13+
{
14+
"skipUrlPatterns": [
15+
"^https://www\\.gnu\\.org/software/wget/"
16+
]
17+
}
18+
],
1219
"remark-lint-no-duplicate-defined-urls",
1320
"remark-lint-no-duplicate-definitions",
1421
"remark-lint-no-empty-url",

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,12 +169,26 @@ Contributions to this project are welcome. Clone this repository, create a new b
169169
If unsure whether the changes you are proposing would be welcome, open an issue first to discuss your proposal.
170170
171171
172+
## Funding
173+
174+
This project is part of the [PHPCSStandards Open Collective](https://opencollective.com/php_codesniffer) and financial support for this project is always appreciated!
175+
176+
172177
## Copyright and License
173178
174-
The phpcsstandards/xmllint-validate GitHub Action is ©copyright PHPCSStandards and contributors and licensed for use under the terms of the MIT License (MIT).
179+
The phpcsstandards/xmllint-validate GitHub Action is [©copyright PHPCSStandards and contributors](https://github.com/PHPCSStandards/xmllint-validate/graphs/contributors) and licensed for use under the terms of the MIT License (MIT).
175180
Please see [LICENSE](LICENSE) for more information.
176181
177182
183+
### Other Credits
184+
185+
This action gratefully makes use of the following externally provided tools which are each governed by their own licensing:
186+
187+
* [`xmllint](https://gnome.pages.gitlab.gnome.org/libxml2/xmllint.html)
188+
* [`xmllint-problem-matcher`](https://github.com/korelstar/xmllint-problem-matcher)
189+
* [`wget`](https://www.gnu.org/software/wget/)
190+
191+
178192
[Composer]: https://getcomposer.org
179193
[PHPUnit]: https://phpunit.de/index.html
180194
[PHP_CodeSniffer]: https://github.com/PHPCSStandards/PHP_CodeSniffer

0 commit comments

Comments
 (0)