How this command is triggered — by the user, by Claude, or both
Slash command
/am-plugin:readme-generateThe summary Claude sees in its command listing — used to decide when to auto-load this command
Tu dois générer un README.md complet pour ce projet en te basant sur le codebase réel. ## Étape 1 — Analyse complète du projet Exécute toutes ces commandes : ## Étape 2 — Plan Propose un plan de README à l'utilisateur avec les sections que tu recommandes, basé sur : - Le type de projet détecté (portfolio, lib, app, API, CLI...) - L'audience probable (recruteurs, devs, utilisateurs finaux) - Les features réelles trouvées dans le code Attends la validation avant de rédiger. ## Étape 3 — Rédaction Rédige le README en suivant strictement la structure canonique et les guidelines du skil...
Tu dois générer un README.md complet pour ce projet en te basant sur le codebase réel.
Exécute toutes ces commandes :
cat package.json
git remote -v
cat LICENSE 2>/dev/null
cat .env.example 2>/dev/null
cat tsconfig.json 2>/dev/null | head -20
find src -type f -name "*.ts" -o -name "*.tsx" -o -name "*.astro" -o -name "*.vue" -o -name "*.svelte" 2>/dev/null | head -30
ls -R src/ 2>/dev/null | head -40
cat src/pages/index.astro 2>/dev/null || cat src/app/page.tsx 2>/dev/null || cat src/App.tsx 2>/dev/null | head -30
Propose un plan de README à l'utilisateur avec les sections que tu recommandes, basé sur :
Attends la validation avant de rédiger.
Rédige le README en suivant strictement la structure canonique et les guidelines du skill readme-editor. Chaque information doit provenir du codebase — ne rien inventer.
Vérifie la quality checklist. Présente le résultat final.
Si l'utilisateur a précisé des instructions : $ARGUMENTS
npx claudepluginhub astyanm/claude-am-plugin --plugin am-plugin/readme-makerAnalyzes project structure and generates a professional README.md with quick start, feature documentation, and contributing guidelines. Also supports --style, --output, and --dry-run flags.
/generate-readmeGenerates README.md by analyzing project files, detecting language/framework, extracting metadata/installation/usage, and adding badges/TOC.
/update-readmeUpdates or creates README.md reflecting current project state with installation, quick start, usage, development sections, badges, and verified examples. Shows diff if updating.
/docsGenerate or update project documentation from codebase and specs. Scopes: api|readme|deploy|all. Scans files, drafts for approval, tracks in todo.md.