Add package README when publishing to github registery (maven)

Is there a way to specify the package README when publishing artifacts using gradle? (Or using the github API)

If the you have created the file in the root of the project, you can try using _ maven-resources-plugin _ to copy from the root directory to ${baseDir}/src/site/markdown.
Detailed configurations in pom.xml as below, navigate to section _ _:

            <!-- Copy the readme file to the site source files so that a page is generated from it. -->

You also can reference here: