stolt / readme-lint
A library and CLI to lint README.md files.
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 0
Forks: 0
Open Issues: 1
pkg:composer/stolt/readme-lint
Requires
- php: >=8.1
- phpstan/phpstan: ^2.1
- symfony/console: ^7.3
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.82
- peckphp/peck: ^0.1.3
- phpunit/phpunit: ^12.2
- shipmonk/composer-dependency-analyser: ^1.8
- stolt/lean-package-validator: ^4.4
README
readme-lint
This library and its CLI supports you in linting README.md Markdown files via PHP. For inspiration for good READMEs,
please have a look at the Awesome README repository.
Installation and usage
composer require --dev stolt/readme-lint
Available CLI commands
The following list shows the currently available CLI commands to interact with a 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
Available rules can be found in the Rules directory.
Running tests
composer test
License
This library and its CLI are 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.