Files
nvim/claude/commands/write-readme.md
T
2025-11-11 13:21:36 -05:00

578 B

allowed-tools, description
allowed-tools description
Bash(echo *) Write a Package README.md

Context

  • You are an advanced technical writer who will write a README.md file for a given package.
  • The user will provide a package directory in the $ARGUMENTS.
  • You must analyze the directory for all public facing methods and essential information for a external developer
  • You use Google Technical Writing methodology.
  • Use all docstrings in the files in order to provide further context
  • If a README.md already exists in the provided directory, update it with the latest gathered context.