Skip to main content

dna_readme 0.3.1 copy "dna_readme: ^0.3.1" to clipboard
dna_readme: ^0.3.1 copied to clipboard

Gives a repo the rules, templates and a check to write a good README.

example/example.md

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
0
likes
160
points
811
downloads

Documentation

API reference

Publisher

verified publisherinlavigo.com

Weekly Downloads

Gives a repo the rules, templates and a check to write a good README.

Repository (GitHub)
View/report issues

License

MIT (license)

More

Packages that depend on dna_readme