JustHandled Labs
// documentation

README Generator

Generate a README from your actual repo, not a hallucinated guess.

What it does

Most generated READMEs are confident fiction: install steps that were never in the project, scripts that do not exist. README Generator reads what is actually in your repo instead. It scans your manifests, package.json, pyproject.toml, go.mod, and Cargo.toml, and pulls the real install commands, scripts, and dependencies.

The evidence pass is read-only. When asked to create or update documentation, the skill writes README.md in the project root unless you request another path. Review the generated diff before committing it.

What it reads

What the output looks like

readme-generator
> generate a README for this project
 
detected package.json (Node), 4 scripts
deps 12 runtime, 8 dev
wrote README.md
evidence package.json, LICENSE, src/index.ts
TODO add deployment instructions
// independent directory review

Skillstore labels the reviewed package Safe

Skillstore’s versioned audit covers the same two files linked from this page. It retains two capability-review items around optional local help commands and reports no prompt-injection, credential-access, or data-exfiltration intent.

This is review evidence, not a guarantee of no side effects. Read the full Skillstore audit.

// paid next step

The README matches the code. Does the app match its claims?

AI Build Sanity Check looks for mocks, placeholders, swallowed errors, and fake-success endpoints before an AI-built app is called finished.

Questions

What does it read?

Project manifests, existing documentation, entry points, code comments, and license metadata. Supported evidence includes package.json, Python packaging files, go.mod, Cargo.toml, Maven or Gradle files, Makefiles, and LICENSE files.

Will it overwrite my existing README?

When asked to create or update documentation, it writes README.md in the project root unless you request another path. Review the generated diff before committing it.

Which languages does it support?

Node, Python, Go, Rust, and Java, detected from the corresponding manifest files.

Install it directly or inspect the source

This free skill is public. Review the exact files first, or install only this skill from the JustHandled Labs repository.

terminal
npx skills add justhandledlabs/skills --skill readme-generator-free

Documentation that matches the code.

Free on Agensi. Instant download. Works with any agent that reads SKILL.md.

Get README Generator on Agensi