Score your README before you launch. README Spark is a tiny Python CLI that reads a README, gives it a concise quality score, and prints the next fixes that make your GitHub first screen easier to understand.
Launch score: 82/100
Next action: add a screenshot or terminal demo.
Your README is often the first screen people see before they decide whether to try, share, or star a project. README Spark helps maintainers catch the simple launch blockers: unclear value, missing quick start, no demo, weak trust signals, or no next action.
python -m pip install -e .
python -m readme_spark
python -m readme_spark README.mdOr, after installing the package in editable mode:
readme-spark README.md- Clear project purpose in the first screen
- Quick start instructions
- Example output or demo signal
- Practical launch-readiness hints
- A short improvement checklist for maintainers
Launch score: 82/100
Next action: add a screenshot or terminal demo.
- Open-source maintainers preparing a new repository
- Indie hackers polishing a launch page
- Developer-tool authors who want a clearer GitHub first impression
- Contributors reviewing README quality before publishing
README Spark is intentionally small. It does not try to replace human taste, branding, or full documentation review. It focuses on the fast, fixable things that help a visitor understand a project in seconds.
python -m pip install -e .
python -m pytest -qMIT