# Readme Updater

Keep README files current with project changes.

- Repository: https://github.com/alirezarezvani/claude-code-tresor (782 stars)
- Category: Engineering
- License: MIT
- Last updated: 2026-07-03
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add alirezarezvani/claude-code-tresor --skill readme-updater -g -a claude-code -y`
Codex: `npx skills add alirezarezvani/claude-code-tresor --skill readme-updater -g -a codex -y`
Cursor: `npx skills add alirezarezvani/claude-code-tresor --skill readme-updater -g -a cursor -y`
Gemini CLI: `npx skills add alirezarezvani/claude-code-tresor --skill readme-updater -g -a gemini-cli -y`

## 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.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 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

The rest: https://github.com/alirezarezvani/claude-code-tresor/blob/HEAD/skills/documentation/readme-updater/SKILL.md