# update-readme

Скилл update-readme для Claude Code обновляет существующий README.md по текущему состоянию кода, истории git и CHANGELOG. Обновляет документацию, сверяя её с проектом.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 276 у репозитория
- Автор: Samarth Gupta
- Лицензия: не указана · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/gupsammy/Claudest/tree/HEAD/plugins/claude-coding/skills/update-readme/SKILL.md
- Обновлён: 2026-10-29
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/update-readme

## Что делает

Скилл проходит по существующему `README.md` по шагам, а не пишет файл заново. Сначала вызывает `claude-coding:make-changelog`, чтобы `CHANGELOG.md` догнал текущую версию, потом запускает три субагента `Explore` одним сообщением: один проверяет каждый заголовок на устаревшие версии, битые пути и незаполненные плейсхолдеры, второй читает манифест и структуру каталогов, третий собирает коммиты после последнего изменения README.

Правки идут по приоритету: сначала версии и бейджи shields.io, затем устаревшие пути и команды, потом плейсхолдеры, новые фичи из коммитов и CHANGELOG, и в конце недостающие разделы вроде установки или API. Мелкие правки вносятся через `Edit`, чтобы не терять git blame; `Write` применяется, только если меняется больше 60% файла. В конце печатается сводка: сколько было строк и сколько стало, какие разделы тронуты, поднялась ли версия.

Без git-истории `make-changelog` вернёт ошибку, и обновление пойдёт дальше без контекста changelog — раздел с фичами тогда опирается только на сканирование кода. Если README нет или в нём меньше 5 строк реального текста, скилл передаёт работу `claude-coding:make-readme` и на этом останавливается.

## Установка

### Claude Code (родная платформа)

1. **Через маркетплейс плагинов**
В чате агента (не в терминале):
```text
/plugin marketplace add gupsammy/Claudest
```
В чате агента (не в терминале):
```text
/plugin install claude-coding@Claudest
```
Команда ставит плагин claude-coding целиком, со всеми его скиллами

2. **Через Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill update-readme -a claude-code
```

3. **Вручную: положить файлы**
- Файл: `~/.claude/skills/update-readme/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/update-readme/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill update-readme -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/update-readme/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill update-readme -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/update-readme/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install gupsammy/Claudest plugins/claude-coding/skills/update-readme
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/update-readme/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill update-readme -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/gupsammy/Claudest --path plugins/claude-coding/skills/update-readme
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/update-readme/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/gupsammy/Claudest/tree/HEAD/plugins/claude-coding/skills/update-readme/SKILL.md

## Когда брать
- подтянуть версию и бейджи в README к текущему манифесту
- вычистить плейсхолдеры вроде `YOUR_USERNAME` и `TODO`
- найти устаревшие пути и команды после переименования файлов
- дописать разделы установки и API, которых не хватает
- собрать список новых фич из коммитов после последнего обновления README

## Примеры запросов агенту
- Обнови README, он разошёлся с кодом
- Синхронизируй README с кодовой базой и историей git
- README устарел, поправь разделы и версию

## Похожие
- [readme-generator](https://affpapa.org/nevibecode/agents/readme-generator.md) — субагент · ★ 26718 у репозитория
- [readme-updater](https://affpapa.org/nevibecode/skills/readme-updater.md) — скилл · ★ 788 у репозитория
- [readme-blueprint-generator](https://affpapa.org/nevibecode/skills/readme-blueprint-generator.md) — скилл · 9662 установки
- [indexion-readme](https://affpapa.org/nevibecode/skills/indexion-readme.md) — скилл · 5100 установок
- [docs-updater](https://affpapa.org/nevibecode/skills/docs-updater.md) — скилл · 3700 установок
- [update-docs-on-code-change](https://affpapa.org/nevibecode/rules/update-docs-on-code-change.md) — правило · ★ 41430 у репозитория

Из того же набора: [gupsammy/claudest](https://affpapa.org/nevibecode/by/gupsammy/claudest.md) — 47 карточек

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
