Loading...
Loading...
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.
npx skill4agent add ovachiever/droid-tings readme-updater# 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# You add: npm install stripe
# I suggest:
## Installation
```bash
npm install
npm install stripe # Added for payment processingSTRIPE_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# Suggested additions:
## Prerequisites
- Node.js 18+
- Docker (for development)
- PostgreSQL 14+
## Environment Variables
```bash
DATABASE_URL=postgresql://localhost/mydb
API_KEY=your_api_keynpm test
### Update Examples
```markdown
# Before:
```javascript
const result = api.getUsers();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)## 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# I suggest when UI changes:
## Screenshots

*Updated: 2025-10-24 - New authentication panel*

*New feature - user profile management*# Project Name
Brief description
## Features
- Feature 1
- Feature 2
## Installation
```bash
npm install// Example
### 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]/docs-gen --format markdown
# Generates:
# 1. README.md (via me)
# 2. Full documentation site (via @docs-writer)
# 3. API reference (via api-documenter)# .github/workflows/docs.yml
- name: Update README
run: |
# Skill suggests updates based on changes
# Review and commitcp -r ~/.claude/skills/documentation/readme-updater \
~/.claude/skills/documentation/company-readme-updater
# Edit to add:
# - Company README template
# - Required sections
# - Badge standards