Can this skill update existing READMEs without overwriting my manual notes?

Yes, the modify operation uses specific markers and preservation rules to keep your custom prose, descriptions, and manual notes intact while updating dynamic content like versions and badges.

Does it automatically add images or logos?

Yes, it checks for existing logos and, if missing, can invoke the project-logo-author skill to generate one, automatically formatting it for retina displays using proper HTML width attributes.

How does the validation scoring work?

The skill audits your README against four tiers—Essential, Professional, Elite, and Virality—assigning weighted scores and providing actionable feedback to reach 'Elite' status.

What is the Hook-Prove-Enable-Extend framework?

It is a strategic documentation structure designed to capture attention in 3 seconds (Hook), build credibility in 30 seconds (Prove), lead to successful installation in 10 minutes (Enable), and provide deep engagement for long-term users (Extend).

Project README Author

Name: Project README Author
Author: tsilva

bytsilva

0•

コンテンツ管理

Generates and optimizes high-conversion GitHub README files using professional marketing frameworks and technical best practices.

Project README Author is a specialized Claude Code skill designed to transform technical documentation into high-impact landing pages for GitHub repositories. It automates the creation of professional hero sections, generates logos, and structures content using the 'Hook-Prove-Enable-Extend' framework to ensure users understand a project's value within seconds. Whether you're launching a new CLI tool, an AI library, or a web app, this skill ensures your documentation includes essential social proof, clear calls-to-action, and optimized visuals that drive engagement and 'aha' moments while preserving your unique manual notes.

主な機能

01Project-specific templates for CLI tools, libraries, AI/ML, and web applications

020 GitHub stars

03Smart preservation of custom prose and manual notes during documentation updates

04Automated logo generation and retina-ready image formatting integration

05Deterministic operation detection for creating, modifying, validating, or optimizing files

06Validation scoring across Essential, Professional, Elite, and Virality tiers

ユースケース

01Auditing existing documentation to improve user retention and time-to-first-success

02Standardizing README structures and badges across a company's repository portfolio

03Launching a new open-source project with a professional, high-conversion landing page

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tsilva/claude-skills project-readme-author

For use in Claude.ai and ChatGPT

Download Skill