Help us improve
Share bugs, ideas, or general feedback.
From readme-standard
Enforces a consistent README.md + README.tr.md structure across projects. Use when: - "readme oluştur" / "create readme" / "yeni readme" → Create mode: generates both README.md and README.tr.md from scratch - "readme kontrol et" / "audit readme" / "readme'yi incele" → Audit mode: prints a checklist report, writes no files - "readme düzelt" / "fix readme" / "readme standardize et" / "readme'yi güncelle" → Fix mode: rewrites existing README(s) to match the standard - "tr readme güncelle" / "sync tr readme" / "türkçe readme güncelle" → TR Sync mode: regenerates README.tr.md only from current README.md Supports Turkish and English triggers. Reads package.json / .csproj / pyproject.toml / SKILL.md to auto-detect project type, name, version, and description for badge generation. Standard: README.md is English-only with a TR reference link; README.tr.md is a full Turkish mirror with identical badges and untranslated code blocks.
npx claudepluginhub sametbrr/skill-hub --plugin readme-standardHow this skill is triggered — by the user, by Claude, or both
Slash command
/readme-standard:readme-standardThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
```
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.
Designs test strategies and plans with testing pyramid. Covers APIs, frontend, data pipelines, infrastructure; outputs plans including coverage targets, examples, and gaps.
Share bugs, ideas, or general feedback.
[badges]
[nav line] ← include only if ≥8 sections or ≥200 lines (Rule 14)
# Project Name
One-line description.
> 🇹🇷 Türkçe için [README.tr.md](README.tr.md)
[value paragraph] ← include only if published package/product (Rule 20)
---
## Quick Start
## Features ← table form if ≥7 features (Rule 19)
## Requirements
## Installation
### Uninstall ← include only if project installs something persistent
## Usage ← per-command template if CLI/plugin (Rule 21)
## Configuration ← include only if user-facing config exists
## How It Works ← include only if internal mechanics are non-obvious
## Project Structure ← include only for multi-component projects
## Limitations ← include only if known user-facing constraints exist
## Troubleshooting ← include only if predictable failure scenarios exist
## Contributing ← include only if contributions are accepted
## Community ← include only if community channels exist
## Documentation ← include only if external docs site exists
## License
[footer] ← include only if GitHub repo and ≥200 lines (Rule 23)
Section selection is governed by Conditional sections below: a conditional section is included only when its detection signal is present, and is never emitted empty or as a placeholder.
Mirror of README.md with these rules:
> 🇬🇧 For English see [README.md](README.md)Each optional section has a defined inclusion condition and detection signal. Check the signals during Create and Fix modes; include the section only when the signal is present.
| Section | Placement | Include when | Detection signal |
|---|---|---|---|
| Value paragraph | After TR link, before first --- | Published package/product | npm/NuGet/PyPI badge generated; package.json not private |
### Uninstall | Subsection of Installation | Project installs something persistent | global install (-g), installer script, hook/MCP config writes, PATH changes |
| Configuration | After Usage | User-facing config exists | config file schema, env vars, settings file in code |
| How It Works | After Configuration | Internal mechanics non-obvious | multi-step pipeline, background process, index/cache mechanism |
| Project Structure | After How It Works | Multi-component project | multiple top-level modules/packages |
| Limitations | After Project Structure | Known user-facing constraint exists | documented constraint, known issue, platform limit |
| Troubleshooting | After Limitations | Predictable failure scenarios exist | external dependency (gh, docker, API key), auth/network step, multi-step install |
| Contributing | After Troubleshooting | Contributions accepted | CONTRIBUTING.md, public repo + dev/test scripts |
| Community | After Contributing | Community channels exist | Discord/Slack/forum/discussions link |
| Documentation | After Community | External docs site exists | docs URL (homepage field, published docs/) |
| Footer | After License, last element | GitHub repo + README ≥200 lines | git remote is GitHub + line count |
Rules:
⚠️ 'Uninstall' present but project installs nothing persistent⚠️ Project installs globally; 'Uninstall' section recommendedRead these files in order (first match wins):
| File | Project type | Extract |
|---|---|---|
package.json | npm package | name, description, version, repository.url |
*.csproj | NuGet package | <PackageId> or <AssemblyName>, <Version>, <Description> |
pyproject.toml | Python package | [project] name, version, description |
SKILL.md | Claude Code skill | name, description frontmatter fields |
| No match | Generic/library | directory name + git remote |
GitHub username and repo: git remote get-url origin → parse from URL.
If no git remote exists, ask the user explicitly.
Monorepo / multiple manifests (tiebreakers):
package.json beats pyproject.toml, etc.).Exact markdown for each type: references/badge-patterns.md
| Project type | Badges |
|---|---|
| NuGet package | NuGet version + downloads + MIT license |
| npm package | npm version + MIT license |
| CLI / skill | GitHub release + MIT + agentskills.io + Claude Code |
| Generic | GitHub release + MIT license |
Full rules with correct/wrong examples: references/rules.md
**EN:** ... **TR:** ... inline bilingual patterns — ever> 🇹🇷 Türkçe için [README.tr.md](README.tr.md)> 🇬🇧 For English see [README.md](README.md)## section — MIT — see [LICENSE](LICENSE).--- horizontal rule between every ## section (blank line above and below)>), no multi-paragraph• separator**Symptom** — solution pattern; Limitations = constraint + reason + workaround<details> only for secondary depth (alternative paths, methodology) — primary path never collapsed> **⚠️ Important:**, > **Note:**, > **Heads up:** — no freeform variants### subsectionsassets/Report Bug · Request Feature, centered) after License — GitHub repos ≥200 lines onlyQuick lookup: references/tr-translations.md