Project README

Create or improve a project README that matches its audience, uses verified repository facts, and keeps optional sections relevant.

Helpful when

• You are starting a README for an existing project.
• A README has grown inconsistent, incomplete, or hard to scan.
• You want to audit whether a README serves users without exposing contributor-only detail.

What to share with Pi

• The repository and whether you want to create, update, harmonize, or review its README
• Whether you want advanced user or contributor documents alongside it
• The primary audience and any repository-specific documentation rules
• Important user workflows, safety constraints, and verified image paths

Try asking

Update this CLI project's README for end users. Preserve its verified usage and safety warnings, and ask me separately whether to create TECHNICAL.md for advanced users and DEVELOPMENT.md for contributors before moving detailed content.

What you’ll get

• A README structure adapted to the project and its primary audience
• Evidence-based wording that does not invent commands, features, compatibility, or visuals
• Clear gaps, conditional-section decisions, and links to deeper documentation where appropriate
• Separate advanced user and contributor documents when useful, created only after you approve each file

Keep in mind

Pi follows repository-local documentation rules first. A README request does not approve companion-file creation. You can approve either companion, both, or neither; existing documents are not overwritten without permission.

For visual user products, Pi asks for missing Main Window and common-feature images or an explicit choice to continue without them. It does not invent or capture visuals. Review proposed changes before applying them to important documentation.

This package is not installed automatically and is not enabled automatically. Installation requires explicit authorization. There are no runtime package dependencies.

Install

pi install npm:@firstpick/pi-skill-project-readme

Restart Pi if the skill does not appear in your current session.

Technical details

See TECHNICAL.md for advanced usage, compatibility, safety, and limitations.