Skills
.Work. You
Rest

readme-refresh

Community

Automate README audit and update, keep project documentation current.

Software Engineering#project management#documentation#audit#update#README
Authorjoshukraine
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill automates the process of auditing and updating a project's README file, ensuring it accurately reflects the current state of the project and its dependencies.

Core Features & Use Cases

  • Audit Mode: Compare project facts with the README to detect outdated, missing, or stale information.
  • Bootstrap Mode: Generate a new README if one doesn't exist, based on project facts and conventions.
  • Tech Stack Detection: Automatically detect tech stack, versions, and services used in the project.
  • Command-Line Interface: Use simple commands to trigger the skill's functionality.

Quick Start

Run the readme-refresh skill to audit the README of the current project directory.

Dependency Matrix

Required Modules

None required

Components

scripts

💻 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: readme-refresh
Download link: https://github.com/joshukraine/dotfiles/archive/main.zip#readme-refresh

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.