MCPInstall

readme-updater

Keep README files current with project changes. Use when project structure changes, features added, or setup instructions modified. Suggests README updates based on code changes. Triggers on significant project changes, new features, dependency changes.

Installs
99
Last 24h
—
Trending rank
—
Security
Not audited

Install

Works with every agent the skills CLI supports.

npx skills add https://github.com/ovachiever/droid-tings --skill readme-updater
  1. 01

    Install

    Run the command in your project. The CLI asks which agents to install for.

  2. 02

    Describe the task

    Ask your agent for something this skill covers. It loads readme-updater automatically when relevant.

  3. 03

    Review the result

    The agent follows the SKILL.md steps, scripts and references bundled with the skill.

SKILL.md

The instructions your agent reads when the skill is triggered.

README Updater Skill

Keep your README current with project changes.

When I Activate

  • ✅ New features added
  • ✅ Project structure changes
  • ✅ Dependencies added/removed
  • ✅ Setup instructions change
  • ✅ User mentions README or documentation
  • ✅ Configuration files modified

What I Update

README Sections

Installation:

  • New dependencies
  • Setup steps
  • Prerequisites
  • Environment variables

Features:

  • New capabilities
  • Functionality changes
  • Feature deprecation

Usage:

  • API changes
  • New examples
  • Updated screenshots

Configuration:

  • New options
  • Environment variables
  • Config file changes

Examples

New Feature Addition

# You add authentication:
git diff
# + auth.service.ts
# + login.component.tsx
# + JWT middleware

# I suggest README update:
## Features
- ✨ User authentication with JWT  # NEW
- 🔐 Role-based access control    # NEW
- User management
- Dashboard

New Dependency

# You add: npm install stripe

# I suggest:
## Installation

```bash
npm install
npm install stripe  # Added for payment processing

Environment Variables

STRIPE_SECRET_KEY=your_stripe_key  # Required for payments

### Setup Instructions

```bash
# You modify docker-compose.yml

# I update README:
## Development Setup

```bash
# 1. Clone repository
git clone [url]

# 2. Install dependencies
npm install

# 3. Start services (UPDATED)
docker-compose up -d  # Now includes Redis cache

# 4. Run migrations
npm run migrate

## Detection Logic

### Change Analysis

I detect these changes automatically:
- **package.json** → Update dependencies section
- **New routes** → Update API documentation
- **.env.example** → Update environment variables
- **docker-compose.yml** → Update setup instructions
- **New features** → Update features list

### Section Mapping

```yaml
Code Change → README Section:
  - New API endpoint → Usage / API Reference
  - New dependency → Installation
  - New env var → Configuration
  - New feature → Features list
  - Architecture change → Architecture section

Intelligent Updates

Keep Structure

I maintain your README structure:

  • Preserve emoji style
  • Keep formatting consistent
  • Maintain tone and voice
  • Respect existing organization

Add Missing Sections

# Suggested additions:

## Prerequisites
- Node.js 18+
- Docker (for development)
- PostgreSQL 14+

## Environment Variables
```bash
DATABASE_URL=postgresql://localhost/mydb
API_KEY=your_api_key

Testing

npm test

### Update Examples

```markdown
# Before:
```javascript
const result = api.getUsers();

After (API changed):

const result = await api.getUsers({ page: 1, limit: 10 });

## Version Compatibility

I track version-specific documentation:

```markdown
## Requirements

- Node.js 18+ (updated from 16+)
- TypeScript 5.0+ (new requirement)
- React 18+ (unchanged)

Changelog Integration

I can sync with CHANGELOG.md:

## Recent Changes

See [CHANGELOG.md](CHANGELOG.md) for detailed version history.

### Latest (v2.1.0)
- ✨ Added user authentication
- 🔧 Fixed memory leak in data processing
- 📝 Updated API documentation

Screenshot Management

# I suggest when UI changes:
## Screenshots

![Dashboard](screenshots/dashboard.png)
*Updated: 2025-10-24 - New authentication panel*

![User Profile](screenshots/profile.png)
*New feature - user profile management*

Relationship with @docs-writer

Me (Skill): Keep README current with code changes @docs-writer (Sub-Agent): Comprehensive documentation strategy

Workflow

  1. I detect changes
  2. I suggest README updates
  3. For full docs → Invoke @docs-writer sub-agent
  4. Sub-agent creates complete documentation

Sandboxing Compatibility

Works without sandboxing: ✅ Yes Works with sandboxing: ✅ Yes

  • Filesystem: Writes to README.md
  • Network: None required
  • Configuration: None required

Best Practices

  1. Keep it current - Update README with every feature
  2. Be specific - Include version numbers, prerequisites
  3. Add examples - Show actual usage, not just API
  4. Include troubleshooting - Common issues and solutions
  5. Badge status - Keep build/coverage badges current

README Templates

Basic Structure

# Project Name

Brief description

## Features
- Feature 1
- Feature 2

## Installation
```bash
npm install

Usage

// Example

Configuration

Environment variables needed

Contributing

How to contribute

License

MIT


### Comprehensive Structure

```markdown
# Project Name
> Tagline

[Badges]

## Table of Contents
- Features
- Installation
- Usage
- API Reference
- Configuration
- Development
- Testing
- Deployment
- Contributing
- License

[Sections with detailed content]

Integration

With /docs-gen Command

/docs-gen --format markdown

# Generates:
# 1. README.md (via me)
# 2. Full documentation site (via @docs-writer)
# 3. API reference (via api-documenter)

With CI/CD

# .github/workflows/docs.yml
- name: Update README
  run: |
    # Skill suggests updates based on changes
    # Review and commit

Customization

Add company-specific README standards:

cp -r ~/.claude/skills/documentation/readme-updater \
      ~/.claude/skills/documentation/company-readme-updater

# Edit to add:
# - Company README template
# - Required sections
# - Badge standards

Related Tools

  • api-documenter skill: API documentation
  • @docs-writer sub-agent: Comprehensive docs
  • git-commit-helper skill: Commit messages for updates
  • /docs-gen command: Full documentation generation

FAQ

What does the readme-updater skill do?

Keep README files current with project changes. Use when project structure changes, features added, or setup instructions modified. Suggests README updates based on code changes. Triggers on significant project changes, new features, dependency changes.

How do I install readme-updater?

Run npx skills add https://github.com/ovachiever/droid-tings --skill readme-updater in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/readme-updater/ (personal) or .claude/skills/readme-updater/ (project).

Which AI agents can use readme-updater?

Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.

Is readme-updater safe to install?

No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.

Who maintains readme-updater?

It is published by ovachiever in ovachiever/droid-tings. It has 99 recorded installs.

More from ovachiever/droid-tings

View all →

security-auditor

ovachiever/droid-tings

Continuous security vulnerability scanning for OWASP Top 10, common vulnerabilities, and insecure patterns. Use when reviewing code, before deployments, or on file changes. Scans for SQL injection, XSS, secrets exposure, auth issues. Triggers on file changes, security mentions, deployment prep.

Security780 installs

react-hook-form-zod

ovachiever/droid-tings

Build type-safe validated forms in React using React Hook Form and Zod schema validation. Single schema works on both client and server for DRY validation with full TypeScript type inference via z.infer. Use when: building forms with validation, integrating shadcn/ui Form components, implementing multi-step wizards, handling dynamic field arrays with useFieldArray, or fixing uncontrolled to controlled warnings, resolver errors, async validation issues.

Frontend & Design722 installs

deep-reading-analyst

ovachiever/droid-tings

Open the skill to read its SKILL.md instructions.

281 installs

nextjs-shadcn-builder

ovachiever/droid-tings

Open the skill to read its SKILL.md instructions.

Frontend & Design262 installs

playwright browser automation

ovachiever/droid-tings

Complete browser automation with Playwright. Auto-detects dev servers, writes clean test scripts to /tmp. Test pages, fill forms, take screenshots, check responsive design, validate UX, test login flows, check links, automate any browser task. Use when user wants to test websites, automate browser interactions, validate web functionality, or perform any browser-based testing.

reportlab

ovachiever/droid-tings

Open the skill to read its SKILL.md instructions.

136 installs

Popular docs & writing skills

View category →

grill-with-docs

mattpocock/skills

A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.

Docs & Writing1.2M installs

lark-markdown

open.feishu.cn

飞书 Markdown:查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件,或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档,也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。

Docs & Writing778.7K installs

writing-beats

mattpocock/skills

Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.

Docs & Writing490.7K installs

writing-shape

mattpocock/skills

Writing, exploit: shape raw material into an article, paragraph by paragraph.

Docs & Writing490.2K installs

writing-fragments

mattpocock/skills

Writing, explore: mine raw fragments, no structure yet.

Docs & Writing489.6K installs

writing-for-agents

mattpocock/skills

Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.

Docs & Writing479.3K installs