Skills
.Work. You
Rest

setup-readme

Community

Bootstrap or refresh your repository's README with real details.

Software Engineering#automation#versioning#repository#README#build configuration
Authoralbertoirurueta
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Crafting a comprehensive and up-to-date README from scratch is time-consuming. This Skill automates the process, ensuring your README reflects the current state of your repository.

Core Features & Use Cases

  • Automatic Content Generation: Creates or updates a README with information extracted from your repository's files and configuration.
  • Real-time Details: Uses the actual repository contents to generate sections like project identity, badges, project status, documentation links, and installation instructions.
  • Non-Intrusive: Shows a diff if a README already exists, allowing you to review proposed changes before applying them.

Quick Start

To generate a README, simply invoke the skill with the command: /setup-readme.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: setup-readme
Download link: https://github.com/albertoirurueta/ai-catalog/archive/main.zip#setup-readme

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 620,000+ vetted skills library on demand.