@readme-generatorREADME pro depuis l'analyse réelle de ton repo
Maifady est un plugin Claude Code 100% gratuit avec 30 agents IA — @readme-generator écrit le README.md complet de ton projet en lisant les vrais fichiers : manifest (package.json / Cargo.toml / composer.json), scripts, .env.example, CI configs, LICENSE. Quick-start copy-pasteable, sections cohérentes, zéro filler.
Le problème qu'il résout
Tu reprends un projet sans README. Tu sais que tu vas devoir l'écrire — sinon le prochain dev (peut-être toi dans 6 mois) va perdre 2 heures à comprendre comment lancer le truc. Mais écrire un README correct prend 1-2 heures de réflexion, et tu n'as pas envie.
@readme-generator le fait en 30 secondes, basé sur ce qui existe vraiment dans le repo.
Comment il bosse
- Détecte la stack via les manifests :
package.json,Cargo.toml,pyproject.toml,composer.json,go.mod,Gemfile,pom.xml. - Lit les scripts disponibles (
npm run, Makefile, etc.) — quick-start utilise les VRAIES commandes du projet. - Globe
tests/,.github/workflows/,Dockerfile,docs/pour détecter les patterns. - Compose les sections : Title, Features, Quick start, Usage, Configuration, Development, License.
- Si une section n'a pas de contenu réel à mettre, elle est omise. Pas de "TODO: add description".
Exemple concret
Tu tapes
›@readme-generator analyse ce repo et écris un README.md complet. Langue : français.
Tu obtiens (extrait)
# Tasky — Mini-Todoist multi-tenant Application de gestion de tâches en Next.js + Postgres. ## Stack - Next.js 14 (App Router) - Postgres 16 + Prisma 5 - Tailwind CSS + shadcn/ui - NextAuth pour l'authentification ## Quick start \`\`\`bash npm install cp .env.example .env.local npx prisma migrate dev npm run dev \`\`\` Ouvre http://localhost:3000 ## Variables d'environnement - DATABASE_URL — Postgres connection string - NEXTAUTH_SECRET — Secret pour signer les sessions (32+ chars) ...
Pourquoi tu vas l'aimer
Basé sur le réel
Lit les fichiers, pas l'imagination. Si npm run dev n'existe pas, il ne le mentionne pas.
Copy-pasteable
Quick-start = vraies commandes qui marchent. Aucun "configurez X" vague.
Pas de filler
Section sans contenu = section omise. Mieux qu'un "Contributing: TODO".
Bilingue si besoin
Tu demandes FR, EN, ou bilingue → il s'adapte.
Quand l'utiliser
✅ Idéal pour
- Nouveau projet, premier README
- Vieux projet sans README ou avec README pourri
- Avant d'open-sourcer un repo
- Quand tu changes de stack et veux un README à jour
⚠️ Pas adapté quand
- Tu veux du marketing pour ta landing → @tech-writer est mieux placé
- Documentation d'API → @api-doc-generator
Combine avec ces agents
Questions fréquentes
Invente-t-il des choses ?
Non. Il lit les fichiers réels (manifests, scripts, .env.example, LICENSE, CI configs). Si une section n'a pas de contenu réel, elle est omise. Pas de filler.
Et si j'ai déjà un README ?
Il te demande avant d'écraser. Il peut aussi proposer une alternative pour comparer avec l'existant.