skills.rest
saadjs
saadjsCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

readme-maintainer

Generate or update README.md files from verified repository sources.

Updated Feb 1, 2026
Search Tags:#automation#documentation#verification#readme#repository#update
One-click install
npx skills add https://github.com/saadjs/agent-skills --skill readme-maintainer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-maintainer
Source: https://github.com/saadjs/agent-skills/tree/main/skills/readme-maintainer
Command: npx skills add https://github.com/saadjs/agent-skills --skill readme-maintainer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automatically creates or updates README.md files to reflect the true state of a project by deriving content from verifiable sources in the repository. Use it when READMEs are missing, outdated, or require alignment with package configs, build/test scripts, environment examples, licenses, or changelogs.

Core Features & Use Cases

  • Scan the repository for authoritative sources of truth (README.md, package manifests, lockfiles, env samples, licenses, and changelogs) and assemble a consistent documentation outline.
  • Populate and update sections only when evidence exists, preserving existing content and avoiding guessing.
  • Provide a clean, skimmable README that reflects the current project setup and contribution guidelines.

Quick Start

Run the readme-maintainer on a repository to generate or refresh the README.md using verified sources.

Frequently Asked Questions about readme-maintainer

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

FAQPage Schema
How do I automatically update my README to match my current repository configuration?▼

Automating README updates involves scanning the repository for authoritative sources like package manifests, lockfiles, and changelogs, then deriving the documentation content directly from those verified files to ensure accuracy.

What is the best way to generate a README from package manifests and env samples?▼

Generating a README from package manifests and env samples requires scanning the repository for these verifiable sources, then populating documentation sections only when evidence exists to avoid guessing and maintain a concise, skimmable structure.

Can I sync my existing README sections with updated changelogs and licenses without losing content?▼

Yes, syncing existing README sections with updated changelogs and licenses preserves existing content where possible while updating sections based on verified sources, omitting unsupported items without overwriting your manual additions.

Does automated README generation work for projects with missing or outdated documentation?▼

Automated README generation works for projects with missing or outdated documentation by assembling a consistent outline from current configs, scripts, and licenses, ensuring the final output reflects the true project setup.

What are the limitations of deriving README content automatically from repository sources?▼

Deriving README content automatically is limited to verifiable sources within the repository, meaning it omits unsupported items and avoids guessing, which may leave sections empty if no authoritative evidence is found.

Related Skills

Explore More Content & Communication Skills→
nholder88nholder88
2

draft-repo-readme

Draft a README from a repository's source files and commit history.

Community
Intermediate
lie5860lie5860
30

chinese-git-workflow

Generate Git workflows for Gitee, Coding.net, and JihuLab/GitLab.

Community
Intermediate
AbeJitsuAbeJitsu

format-standardize

Apply user-defined formatting standards across code, documentation, and content outputs using ESLint and Prettier.

Community
Basic
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate