From tech-writer
Generate a comprehensive README.md by analyzing the project's code, config, and structure
How this skill is triggered — by the user, by Claude, or both
Slash command
/tech-writer:readme-genThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Style: **$0** (default: standard)
Style: $0 (default: standard)
Analyze the project:
package.json / pyproject.toml / go.mod for project metadataGenerate sections based on style:
.env.example)Generate environment variable documentation:
.env.example if it existsWrite the README:
# Project Name
Brief description of what this project does.
## Tech Stack
- **Runtime**: Node.js 20
- **Framework**: Next.js 14 (App Router)
- **Database**: PostgreSQL + Prisma
- **Styling**: Tailwind CSS
## Getting Started
### Prerequisites
- Node.js >= 20
- PostgreSQL >= 15
### Installation
\`\`\`bash
git clone <repo-url>
cd <project>
npm install
cp .env.example .env
# Edit .env with your values
npx prisma db push
npm run dev
\`\`\`
## Environment Variables
| Variable | Required | Description | Example |
|----------|----------|-------------|---------|
| DATABASE_URL | yes | PostgreSQL connection string | postgresql://... |
## Project Structure
\`\`\`
src/
├── app/ # Next.js routes
├── components/ # React components
├── lib/ # Utilities and config
└── server/ # API logic
\`\`\`
Fetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.
Applies a firm's KYC/AML rules grid to parsed onboarding records: assigns risk rating, checks required documents, outputs rule outcomes with citations, and routes for escalation.
Generates daily or weekly digests of activity from connected sources (chat, email, docs, tasks, CRM), highlighting action items, decisions, mentions, and project updates.
npx claudepluginhub silviaare95/xari-plugins --plugin tech-writer