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.
- Dynamically generates platform badges based on
project.platformsand funding badges fromurls.fundSources. - 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 distributable workspace.
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 | Preview the target file path without writing anything to disk. |
-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 I/we, me/us, my/our usage. |
project.platforms | Determines which platform badges and language logo to include. |
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. |
urls.github | GitHub repository URL used for release, language, and license badges. |
urls.npm | npm package URL — includes npm badges when nodejs is a platform. |
urls.docker | Docker Hub URL — includes Docker Pulls and Image Size badges. |
urls.fundSources | Array of funding URLs — generates badges and credits section. |
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. |