Many npm repos, like npmjs.com, provide an option to publish the content for README.md package file along with the package, for the good reasons:
To help others find your packages on npm and have a good experience using your code in their projects, we recommend including a README file in your package directory. Your README file may include directions for installing, configuring, and using the code in your package, as well as any other information a user may find helpful. The README file will be shown on the package page.
An npm package README file must be in the root-level directory of the package.
(ref: About package README files | npm Docs).
Is there a similar option available in GitLab? I’m adding here a proposal on how it might look like:
Thanks, Marek