readme-and-co:using-local-config

Community

Project-specific defaults for README generation.

Authoraaronbassett
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill enables a project-wide default configuration for the readme-and-co plugin by leveraging a local YAML frontmatter file (.claude/readme-and-co.local.md). This reduces repetitive setup across multiple repositories by applying consistent defaults at generation time.

Core Features & Use Cases

  • Local defaults loading: automatically apply defaults like project_name, author_name, license, and badges from the local config.
  • Priority merging: CLI arguments override the local config, which in turn can be auto-detected or merge with built-in defaults.
  • Use Case: A developer initializes a new project and reuses a shared defaults file to generate consistent READMEs and badge configurations across repos.

Quick Start

Copy the example local config to .claude/readme-and-co.local.md, edit the defaults as needed, and run the render_template command to produce README.md.

Dependency Matrix

Required Modules

None required

Components

scripts

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: readme-and-co:using-local-config
Download link: https://github.com/aaronbassett/aaronbassett-marketplace/archive/main.zip#readme-and-co-using-local-config

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.