stef41/README Lint
Ensure README files contain required sections like Installation, Usage, License, and more. Enforce documentation standards.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| readme-path | Path to README file (or directory to search in) | no | . |
| required-sections | Comma-separated list of required section headings | no | Installation,Usage,License |
| min-length | Minimum README length in characters | no | 200 |
| fail-on-missing | Fail the workflow if required sections are missing | no | true |
Outputs
| name | description |
|---|---|
| missing-sections | Comma-separated list of missing sections |
| readme-length | README length in characters |
| score | Quality score 0-100 |