stolt/readme-lint

A library and CLI tool to lint README.md files.

dev-main 2025-07-11 14:28 UTC

Requires

• php: >=8.1
• symfony/console: ^7.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.82
• peckphp/peck: ^0.1.3
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^12.2
• stolt/lean-package-validator: ^4.4

MIT

• Raphael Stolt

• php
• cli
• lint
• README.md

README

This library and its CLI supports you in linting README.md Markdown files via PHP.

Installation and usage

composer require stolt/readme-lint

Available CLI commands

The following list shows the currently available CLI commands to interact with an README.md file.

php bin/readme-lint list

readme-lint 0.0.1

Available commands:
  lint        Lint a README.md file for common quality issues

Running tests

composer test

License

This library is licensed under the MIT license. Please see LICENSE.md for more details.

Changelog

Please see CHANGELOG.md for more details.

Contributing

Please see CONTRIBUTING.md for more details.