npm-publish-gradle-plugin/dev.petuska.npm.publish.extension.domain/NpmPackage/readme

readme

@get:InputFile
@get:Optional
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val readme: RegularFileProperty

A location of the README.md file. If set, the file will be moved to package assembly root and renamed to README.md (regardless of the actual name). Defaults to NpmPublishExtension.readme

See also