update-readme

Automates README.md and AGENTS.md updates from Git history and project structure using Python scripts.

4|Updated Jan 22, 2026
One-click install
npx skills add https://github.com/oiiiwjh/skills --skill update-readme-oiiiwjh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-readme
Source: https://github.com/oiiiwjh/skills/tree/main/update-readme
Command: npx skills add https://github.com/oiiiwjh/skills --skill update-readme-oiiiwjh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires PyYAML, toml, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the process of updating your project's README.md and AGENTS.md files, ensuring your documentation accurately reflects the current state of your codebase and project structure.

Core Features & Use Cases

  • Automated Documentation Updates: Scans your project directory, analyzes Git history, and updates README and AGENT files.
  • Project Structure Visualization: Automatically generates or updates project structure diagrams.
  • Use Case: After adding a new feature or refactoring code, run this Skill to ensure your README is updated with the latest information, including new dependencies, updated Git logs, and relevant project structure changes.

Quick Start

Use the update-readme skill to automatically refresh the project's README.md file.

Frequently Asked Questions about update-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically update README.md based on Git history and project structure?

You can automatically update README.md by running a script that scans your project directory, analyzes Git history, and regenerates documentation to reflect codebase changes. This ensures project docs stay synchronized with recent updates.

What is the best way to keep project documentation in sync after refactoring code?

The best way to keep documentation in sync is to automate generation using Python scripts that analyze your repository. This process updates README files with new dependencies and structural changes after code refactoring.

Does this automated documentation generation work with various project types?

Yes, automated documentation generation supports various project types. It utilizes Python scripts to analyze project structures and Git history, ensuring compatibility across different codebases for maintaining up-to-date files.

Can I automatically generate AGENTS.md files alongside README updates?

Yes, you can automatically generate and update AGENTS.md files alongside README.md. The tool scans your project structure and Git history to keep both documentation files accurately synchronized with your current codebase.

What dependencies do I need to automate project documentation updates?

To automate project documentation updates, you need PyYAML and toml dependencies installed. These libraries allow the Python scripts to parse project configuration files and generate updated documentation.

How does project structure visualization work in generated README files?

Project structure visualization works by automatically generating or updating directory diagrams within your README. The script scans the codebase to map out current files and folders, reflecting structural changes accurately in the documentation.