Agent skill
readme-updates
Maintain README files with setup instructions, features, tech stack, and usage examples. Use when updating project documentation, adding new features, improving onboarding, or creating READMEs for new packages.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/readme-updates
SKILL.md
README Updates Skill
Root README Structure
# SG Cars Trends
[](LICENSE)
[](https://github.com/sgcarstrends/sgcarstrends/actions)
> Platform for accessing Singapore vehicle registration and COE bidding data
## Features
- 📊 **Comprehensive Data**: Car registration and COE bidding data
- 🔄 **Real-time Updates**: Automated daily updates from LTA DataMall
- 📝 **AI-Generated Blog**: Automated insights using Google Gemini
## Quick Start
\`\`\`bash
git clone https://github.com/sgcarstrends/sgcarstrends.git
cd sgcarstrends
pnpm install
cp .env.example .env
pnpm db:migrate
pnpm dev
\`\`\`
## Tech Stack
- **Frontend**: Next.js 16, HeroUI, Recharts, Tailwind CSS
- **Backend**: Hono, Drizzle ORM, PostgreSQL, Upstash Redis
- **Infrastructure**: SST v3, AWS Lambda, Cloudflare
- **AI**: Google Gemini, QStash workflows
## Project Structure
\`\`\`
sgcarstrends/
├── apps/
│ ├── api/ # Hono API
│ └── web/ # Next.js web app
├── packages/
│ ├── database/ # Drizzle schemas
│ ├── ui/ # UI components
│ └── utils/ # Shared utilities
└── infra/ # SST infrastructure
\`\`\`
## Development
\`\`\`bash
pnpm dev # Start all servers
pnpm test # Run tests
pnpm build # Build for production
\`\`\`
## License
MIT
Package README Template
# @sgcarstrends/[package-name]
> Brief description
## Installation
\`\`\`bash
pnpm add @sgcarstrends/[package-name]
\`\`\`
## Usage
\`\`\`typescript
import { functionName } from "@sgcarstrends/[package-name]";
const result = functionName();
\`\`\`
## API
### `functionName(param: string): ReturnType`
Description.
**Parameters:** `param` (string) - Description
**Returns:** `ReturnType` - Description
## Development
\`\`\`bash
pnpm test
pnpm build
\`\`\`
## License
MIT
Common Badges
[](LICENSE)
[](actions)
[](npm)
[](typescript)
Environment Variables Section
## Environment Variables
Create `.env` from `.env.example`:
\`\`\`env
DATABASE_URL=postgresql://user:pass@localhost:5432/db
UPSTASH_REDIS_REST_URL=https://your-redis.upstash.io
UPSTASH_REDIS_REST_TOKEN=your-token
\`\`\`
Update Checklist
- Features list current when new features added
- Tech stack updated when dependencies change
- Setup instructions accurate when process changes
- Examples working and up-to-date
- Links not broken
Validate README
# Check for broken links
pnpm dlx markdown-link-check README.md
# Lint markdown
pnpm dlx markdownlint README.md
Best Practices
- Clear Description: Concise project description at top
- Quick Start: Immediate value with copy-paste setup
- Working Examples: Test all code examples
- Keep Updated: Update when features change
- Check Links: Regularly verify links work
References
- Shields.io: https://shields.io (badges)
- markdownlint: https://github.com/DavidAnson/markdownlint
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?