GratuitSkills
Commits, branches et synchronisation avec la CLI but
- 361361 téléchargements
- 198198 mentions J'aime
- 103103 sauvegardes
Compatible avec
- Claude Code
- Codex
- Cursor
- et 3 autres
Rédaction de README pour projets logiciels v1.0.0
Utilisez cette ressource pour rédiger ou réviser le README d'un dépôt, d'une bibliothèque ou d'un outil en ligne de commande
Nouveau
- 495 téléchargements
- 133 mentions J'aime
- 228 sauvegardes
Gratuit
Installer avec la CLI
Dans un terminal, depuis le dossier voulu :
npx --yes palatekit@latest install readme-writing-structure-guideSans option, la skill va dans ~/.agents/skills/ ; ajoutez --agent claude-code (ou codex, cursor…) pour viser un agent.
Première fois : connectez la CLI avec
npx --yes palatekit@latest loginL'agent rédige ou relit le README d'un projet : une accroche précise, un exemple de code en tête, une structure standard, la présentation des fonctions et un démarrage rapide. Vous obtenez une page d'accueil claire pour votre dépôt.
Choisie surtout par
Mise à jour le 2 novembre 2026
Aperçus
Caractéristiques
- Fonctionne dans
- Guides d'installation
- Génère avec
- Le modèle de votre agent
- Licence
- Apache-2.0
Ressources similaires
Tout voir- Gratuit
GratuitSkills
Guide de la CLI Sentry
- 525525 téléchargements
- 117117 mentions J'aime
- 128128 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
Bonnes pratiques Drizzle ORM avec PostgreSQL
- 407407 téléchargements
- 194194 mentions J'aime
- 151151 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
Assistant de conception de SLO
- 537537 téléchargements
- 105105 mentions J'aime
- 242242 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
User stories de sprint
- 451451 téléchargements
- 150150 mentions J'aime
- 132132 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
Plan de sprint réaliste
- 423423 téléchargements
- 192192 mentions J'aime
- 102102 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
Conseiller CTO de startup
- 580580 téléchargements
- 201201 mentions J'aime
- 242242 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
Création de pull requests GitHub avec contrôles qualité
- 427427 téléchargements
- 230230 mentions J'aime
- 196196 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
Ce que vous obtenez
- SKILL.md : méthode d'écriture et accroche
- SKILL.md : structure standard, présentation des fonctions et démarrage rapide
- SKILL.md : badges, ressources, section auteur et erreurs à éviter
Pour qui
- Vous publiez une bibliothèque npm ou un outil CLI sans page d'accueil
- Vous réécrivez un README qui ressemble à une référence d'API
Pas pour qui
Étiquettes
- readme
- documentation
- dépôt
- accroche
À propos
Vous dites
« Réécris le README de mon outil CLI avec une accroche, un exemple d'usage et une section d'installation. »
Skill publiée par mindrally sous licence Apache-2.0. Fichiers livrés dans leur version d'origine, en anglais.
Voir plusVoir moins
Comment l'utiliser
- Installez la skill dans le dossier de skills de votre agent
- Demandez à votre agent de rédiger ou réviser le README d'un dépôt, d'une bibliothèque ou d'un outil en ligne de commande
- Relisez et ajustez le résultat
Aperçu du contenu
Fichiers
- LICENSE11,3 Ko
- NOTICE-PALATEKIT.md0,5 Ko
- SKILL.md6,7 Ko
Origine et licence
Référencée sans modification
- Auteur
- mindrally
- Source
- github.com/mindrally/skills/tree/7682ca77710e0971eab4e0ae5dddfa281aea0ba5/readme-best-practices
- Licence
- Apache-2.0
Notice
« readme-best-practices » (mindrally, Apache-2.0) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.
Avis des utilisateurs
–
Aucune note pour l'instant
Chargement des avis…