b1rdmania/readme-generator

b1rdmania-Profil

Letzte erfasste Quellaktivität: 9. Oktober 2026 um 14:38

SkillsMP-Katalog aktualisiert: 17. Oktober 2026 um 00:09

gesammelte Skills: 1

GitHub-Stars: 0
GitHub-Forks: 0

README des Repositorys

README-Quelldatei: README.md

README-Quelldatei lesen

Vollständige README anzeigen

# readme-generator A Claude Code skill that reads a repo and writes its README.md in one pass. It works for skills, CLIs, npm and Python packages, and script collections. It writes no placeholder or TODO sections. ## Install ```bash git clone https://github.com/b1rdmania/readme-generator ~/.claude/skills/readme-generator ``` ## Usage ``` /readme-generator # current directory /readme-generator https://github.com/user/repo # also research the repo on the web /readme-generator --update # update an existing README.md ``` ## What it does ```mermaid flowchart TD A[Read the project] -- config, entry points, SKILL.md --> B{GitHub URL given?} B -- yes --> C[Web research, keep facts the files confirm] B -- no --> D[Classify project type] C -- description, install commands --> D D -- section set --> E[Draft README] E -- README, About line, topics --> F{You approve?} F -- yes --> G[Write README.md, set GitHub About] ``` - Reads config files, entry points, `SKILL.md`, `CLAUDE.md` and any existing README - Picks a section set for the project type and skips sections it cannot fill - Keeps intentional parts of an existing README, such as badges and custom examples - Writes a GitHub About line (160 characters or fewer) and 3 to 6 topics for any repo with a GitHub remote - Adds one Mermaid flowchart when the project has a real multi-step flow - Removes filler words such as "powerful", "robust" and "seamless" ## What it doesn't do - Does not run the project to test the commands. Check them before you publish. - Does not make screenshots or demo GIFs. - Does not overwrite a README.md, or edit the GitHub About, without your approval. ## Requirements Web research is optional. The skill uses the Exa MCP if it is configured, then the built-in WebSearch and WebFetch. With no search tool, it reads the local files only. ## License Apache-2.0

README des Repositorys wird geladen…

Skills in diesem Repository

Klassifizierung ausstehend

Skill

Beruf

Beschreibung

Aktualisiert

readme-generator

nicht klassifiziert

Generates a complete README.md for any repo — software packages, CLI tools, Claude Code skills, or script collections. Reads the local project and, if a GitHub URL is given, also researches it on the web. Writes a publication-ready README in one pass with no…

Quellsprache: Englisch

2026-10-09

Es werden 1 von 1 gesammelten Skills angezeigt.

Mit einem KI-Assistenten installieren

Diesen Prompt kopieren und in den verwendeten KI-Assistenten einfügen.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/b1rdmania/readme-generator.