README Auditor

Score project README coverage for developer handoff quality.

README score
65
6 of 11 checks pass

  • Project title

    README has a top-level project title.

  • Short description

    README explains what the project does near the top.

  • Status badges

    Add npm, build, coverage, or license badges when they help readers evaluate the project.

  • Screenshot or demo

    Add a screenshot, GIF, or architecture diagram with descriptive alt text.

  • Installation

    README includes installation or setup steps.

  • Usage example

    README includes a usage or quick-start section.

  • API or options

    Document functions, CLI flags, configuration options, or component props.

  • Configuration

    README covers environment variables or configuration.

  • Scripts or commands

    Add scripts for test, build, lint, dev, and release workflows.

  • Contributing

    Add contribution steps, issue guidance, or a link to CONTRIBUTING.md.

  • License

    README states the license.