readme-formatting

Format README files with Constructive logos and badges for npm, pnpm, and pgpm packages.

1|Updated Jan 20, 2026
One-click install
npx skills add https://github.com/constructive-io/constructive-skills --skill readme-formatting
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: readme-formatting
Source: https://github.com/constructive-io/constructive-skills/tree/main/skills/readme-formatting
Command: npx skills add https://github.com/constructive-io/constructive-skills --skill readme-formatting

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures all project README files adhere to the Constructive branding guidelines, including consistent header logos and relevant badges, making projects look professional and unified.

Core Features & Use Cases

  • Branded Headers: Automatically adds centered Constructive logos to README files.
  • Dynamic Badges: Includes appropriate badges (CI, License, Version) based on package type.
  • Use Case: When creating a new npm package, use this skill to generate a README with the correct logo and badges, saving you the manual effort of finding and formatting them.

Quick Start

Use the readme-formatting skill to format the README file for a new npm package.

Frequently Asked Questions about readme-formatting

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I format a README file for a new npm package?

To format a README file for a new npm package, you can apply standardized branding guidelines that automatically insert centered header logos and relevant CI, License, and Version badges. This ensures professional project documentation without manual formatting effort.

What is the best way to standardize README headers with logos and badges?

Standardizing README headers with logos and badges involves applying specific logo URLs and badge placement guidelines based on repository structures. This process enforces consistent branding across projects by dynamically generating appropriate badge sets for different package types.

Does README formatting work with pnpm and pgpm package types?

Yes, README formatting applies to npm, pnpm, and pgpm package types. It dynamically adjusts the included badges and branding elements to match the specific package type, ensuring correct documentation standardization across different package managers.

What badges are included when generating a standardized README?

Generating a standardized README includes dynamic badges for CI, License, and Version. The specific badges applied depend on the package type and adhere to defined placement guidelines within the repository structure to maintain visual consistency.

When do I need to standardize README files across a monorepo or multiple modules?

You need to standardize README files across multiple modules during module publishing or new package creation. Standardization ensures all project documentation adheres to unified branding guidelines, including specific logo URLs and badge placements for varying repository structures.