v0.20.0

Changed

• The required Node.js version is now >=20.5.0.
• The license over to the BSD 3-Clause License.

Fixed

• A bug where various methods on the GitHubUrl class were returning false positives for non-GitHub URLs.
• A bug which could cause the app to crash when creating various badges if an invalid repository URL was processed.

---

v0.19.1...v0.20.0

v0.19.1

Security

• Addressed a ReDoS vulnerability in the cross-spawn module, which is a dependency of dependencies.

v0.19.0...v0.19.1

v0.19.0

Changed

• Upgraded readme-md dependency to v1.2.1.
• Now takes packageManager in package.json into account in addition to engines when determining the package manager. See here for reference.
• Changed the wording of "Prefer semicolons in examples?" to "Prefer semicolons in example code?" to be more clear.

v0.18.0...v0.19.0

v0.18.0

Added

• Hero image support. Set the new hero-image property in the config to enable this. See the docs for more details.

Changed

• Upgraded readme-md dependency to v1.1.0.

v0.17.0...v0.18.0

v0.17.0

Added

• Detection of LICENSE.rst license files.
• Detection of lowercase license files (e.g., license, license.md, license.rst, license.txt).
• Interactive mode. Now when readme-md is invoked from the command line you will be prompted with questions. This behavior is negated when running in a CI environment or if the --non-interactive flag is used.

Fixed

• An issue where the default Git branch would not be detected.

v0.16.0...v0.17.0

v0.16.0

Added

• The "shortcut syntax" for the repository property in package.json is now supported. See here for reference.

Changed

• The license badge alt text to be more descriptive.

v0.15.0...v0.16.0

v0.15.0

Added

• Documented the description config option in doc/README.md.
• Detection of pnpm.
• A prefer-npm config option, which can have a Boolean value. Setting this to true will cause the examples in the "Install" and "Testing" sections to always use npm. Defaults to false.
• A prefer-semicolons config option, which can have a Boolean value. This parameter decides whether statements in the autogenerated "Usage" section should be terminated by a semicolon. Defaults to true.
• A quote-type config option, which can have a value of either "double" or "single". This parameter decides what quote type to use in the autogenerated "Usage" section. Defaults to "single".

Changed

• Upgraded meow and readme-md dependencies.
• Updated the generated alt text for badge images to be more descriptive.
• If no .config/readme-md/sections/usage.md file is present a basic "Usage" section will now be autogenerated.

Security

• Addressed three vulnerabilities in dependencies of dependencies by rebuilding the lockfile.

v0.14.0...v0.15.0

v0.14.0

Changed

• Updated "Usage" section of README.md.
• Configuration (e.g., .config/readme-md/config.yaml) variables are now normalized as camelCase internally which means config variables can be in the form of camelCase, kebab-case, snake_case, etc.
• Upgraded yarn-lockfile-exists dependency which improves filepath logic for Windows environments.
• The required Node.js version is now ^18.19.0 || >=20.5.0.

Fixed

• Fix typo in 0.13.0 section of changelog.

v0.13.0...v0.14.0

v0.13.0

Added

• The GitHub Actions badge option has been added to the readme-md init config.

Changed

• Change over to ES Modules from CommonJS.
• The minimum required Node.js is now v16.
• Generated fenced code blocks for shell script (e.g., the Install and Testing sections) no longer have a dollar sign prefix.
• For packages which are MIT licensed the value "(Expat)" is no longer suffixed in the generated License section.
• Passing no license or an empty license will now output "To be documented." in the body of the License section.
• Project config now supports and prioritizes .config/readme-md/config.yaml files. The search order goes like so: config.yaml then config.yml.
• The filepath logic for has been changed to better accommodate Windows environments.
• The alt tags for badge images are now in title case where appropriate.

Removed

• Removed support for Travis-CI badges.

v0.12.0

Changed

• The minimum required Node.js version is now v8.

Fixed

• Addressed an issue which in some cases caused the "binary" to be reported as cli.js instead of readme-md in stderr and stdout dialogs.
• Fixed the readme-md init command breaking when loading its config template.