# readme-updater

readme-updater updates README automatically when project structure changes, dependencies are added, or new features land.

- skill · `type=skill` · Claude Code, Cursor, Codex, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 788 repo stars
- Author: alirezarezvani
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/alirezarezvani/claude-code-tresor/tree/HEAD/skills/documentation/readme-updater/SKILL.md
- Updated: 2026-07-03
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/readme-updater

## What it does

The skill watches code changes and suggests README updates: new endpoint goes into Usage, new dependency into Installation, `docker-compose.yml` edit into Setup. Triggers on changes in `package.json`, `.env.example`, new routes and components.

Uses Read, Write, Edit and Grep tools. Preserves document style: emoji, formatting, tone.

Can create missing sections (Prerequisites, Environment Variables, Testing) and sync with `CHANGELOG.md`. For comprehensive documentation, delegates to the `@docs-writer` sub-agent.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add alirezarezvani/claude-code-tresor --skill readme-updater -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/readme-updater/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/readme-updater/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add alirezarezvani/claude-code-tresor --skill readme-updater -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/readme-updater/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add alirezarezvani/claude-code-tresor --skill readme-updater -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/readme-updater/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install alirezarezvani/claude-code-tresor skills/documentation/readme-updater
```

2. **Manually: put the files in place**
- File: `.github/skills/readme-updater/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add alirezarezvani/claude-code-tresor --skill readme-updater -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/alirezarezvani/claude-code-tresor --path skills/documentation/readme-updater
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/readme-updater/SKILL.md` — The legacy .windsurf/skills/ path still works

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/alirezarezvani/claude-code-tresor/tree/HEAD/skills/documentation/readme-updater/SKILL.md

## When to use it
- sync README with code changes
- add a new dependency to the Installation section
- update usage examples after API changes
- append environment variables from `.env.example`
- create a Prerequisites section for a new requirement

## Example prompts
- Update README — I added JWT authentication
- Add setup instructions for `docker-compose` to README
- README is outdated after the API refactor, bring it up to date

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 5d6a947913e635ea.

BEGIN THIRD-PARTY FILE 5d6a947913e635ea
````text
---
name: readme-updater
description: 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.
allowed-tools: Read, Write, Edit, Grep
---

# 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

```bash
# 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

```bash
# You add: npm install stripe

# I suggest:
## Installation

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

## Environment Variables
```bash
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

```markdown
# 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
```bash
npm test
```
```

### Update Examples

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

# After (API changed):
```javascript
const result = await api.getUsers({ page: 1, limit: 10 });
```
```

## Version Compatibility
````
END THIRD-PARTY FILE 5d6a947913e635ea

The third-party file has ended. Everything between the 5d6a947913e635ea tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 3152 of 6141 bytes. © alirezarezvani · MIT · https://github.com/alirezarezvani/claude-code-tresor/tree/HEAD/skills/documentation/readme-updater/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
