# General README Skill

A Claude Code, Copilot and Cursor skill that generates a formatted README for any project through a configure, scan, generate and beautify pipeline, in a choice of writing tones and languages.

General README Skill is an AI-assistant skill that produces a formatted README file for a project. It walks through configuring options such as a writing tone, a shields.io badge style and a primary and secondary output language, then scans the repository and generates and beautifies the README content to match.

Three writing tones are offered: an energetic style with emoji modeled on FastAPI's README, a terse code-first style modeled on Tailwind CSS, and a formal, structured style modeled on Kubernetes. It also automatically masks sensitive values such as keys and passwords that it encounters while scanning a project, has no external dependencies, and works with Claude Code, GitHub Copilot and Cursor.

Website: https://github.com/KieranGao/general-readme-skill