README (README.md)

Create a baseline README.md populated with project name, description, dynamic badges, documentation links, and a credits section from the Nova config.

Why Use This Command?

Produces a consistent README with shields badges, documentation links, and correct pronoun usage without manual editing.
Generates only the badges selected in readme.badges, preserving their configured order.
Draws every value from nova.config.json, so regenerating after a config change keeps the file in sync.
Automatically copies the generated file into each consumer-facing workspace with the app, package, tool, or config role.

Requirements

Node.js runtime — Use any Node.js LTS release.
Project root — Run the command from the directory containing the top-level package.json.
nova.config.json — A valid config file must exist at the project root with the fields listed below.

Usage

Options

Flag	Description
`-d, --dry-run`	Run without writing any files.
`-r, --replace-file`	Overwrite the existing file instead of creating a `.nova-backup` copy.

Config Fields

Field	Description
`project.name.title`	Display name used in the heading.
`project.description.long`	Long project description shown below the heading.
`project.pronouns`	`"personal"` or `"business"` — controls me/us, my/our usage.
`urls.homepage`	Project homepage URL linked from the logo.
`urls.logo`	Absolute URL to the project logo image.
`urls.documentation`	Documentation site URL used in the links section.
`readme.badges`	Exact ordered badge identifiers to include. Missing and empty arrays produce no badges.
`urls.npm`	npm package URL used by the selected npm badges.
`urls.docker`	Docker Hub URL used by the selected Docker badges.
`github.owner`	GitHub owner — combined with `github.repo` into the repo slug.
`github.repo`	GitHub repo name — joined with `github.owner` for selected GitHub badges.
`urls.fundSources`	Array of funding URLs used by the selected funding badge and credits section.
`entities`	Entities with a `contributor` or `supporter` role are listed by name and URL in the credits section.

Supported Badges

Badges render in the same order as readme.badges. Unknown identifiers, duplicates, and badges without their required source fail config validation.

Identifier	Badge	Required Source
`homebridge`	Homebridge	None.
`homebridge-verified`	Verified Homebridge	None.
`npm-version`	npm version	`urls.npm`.
`npm-downloads`	npm downloads	`urls.npm`.
`docker-pulls`	Docker pulls	`urls.docker`.
`docker-image-size`	Docker image size	`urls.docker`.
`github-release`	Latest GitHub release	`github.owner` and `github.repo`.
`github-top-language`	GitHub top language	`github.owner` and `github.repo`.
`github-license`	GitHub license	`github.owner` and `github.repo`.
`funding`	Funding	At least one `urls.fundSources` entry.

Supported Funding Platforms

Platform	Detected By
GitHub Sponsors	`github.com/sponsors/`
PayPal	`paypal.com/` or `paypal.me/`
Open Collective	`opencollective.com/`
Ko-fi	`ko-fi.com/`
Buy Me a Coffee	`buymeacoffee.com/`
Patreon	`patreon.com/`
Liberapay	`liberapay.com/`

Output Files

File	Description
`README.md`	Project README with badges, links, and description.
`<workspace>/README.md`	A copy of the same README placed in each consumer-facing workspace (roles `app`, `package`, `tool`, and `config`), excluding the root workspace.