dna_readme 0.3.1
dna_readme: ^0.3.1 copied to clipboard
Gives a repo the rules, templates and a check to write a good README.
Example #
dna_readme is a DNA layer: it ships guides, templates, a skill and a
script, no library code. Declare it as a dev dependency and instantiate it
once:
dart pub add dev:dna_readme # Dart projects
pnpm add -D @ggdna/dna-readme # TypeScript projects
helix init
Then type /readme in Claude Code, or check the README yourself:
node scripts/check-readme.js
A README that follows the guide prints:
✓ README matches the guide