readme-generation

Installation
SKILL.md

README Generator

Analyze a codebase and produce a complete, professional README.md.

Parse the user's input to determine:

  • Target: a local path, a remote GitHub repo (e.g., fortra/impacket), or current directory (default)
  • Style: security-tool, library, cli, webapp, minimal, or auto-detect (default)
  • Update mode: if the user says "update" or the project already has a README, preserve custom sections

Common patterns:

  • $readme-generation → generate for current directory, auto-detect style
  • $readme-generation ~/projects/mytool → generate for local path
  • $readme-generation fortra/impacket → clone and generate for remote repo
  • $readme-generation --style security-tool → force a specific style
  • $readme-generation --update → update existing README, keeping custom sections

Steps

1. Acquire the codebase

Installs
4
GitHub Stars
739
First Seen
Sep 4, 2026