Readme Generator

Generates a polished README from your project structure and dependencies. Use when the user asks to write or improve a README.

nir130 Updated

File contents

README Generator

When the user asks for a README:

  1. Inspect the project: entry points, scripts in package.json/pyproject.toml, and the directory layout.
  2. Draft a README with: title, one-line description, features, install, usage, and a project-structure section.
  3. Keep it accurate — only document scripts and commands that actually exist.
  4. Show the draft and ask before overwriting an existing README.

nir130/awesome-agent-skills/tree/main/skills/readme-generator commit 9a50c12c55

Frequently asked questions

npx skillmds@latest add nir130/readme-generator