See discussions in #2385.
Monorepo setup
Our project @maplibre/maplibre-react-native is a monorepo, the README.md is handle like this:
- Placed in the GitHub repository root
/
- Copied during
prepack into the /package directory, removed on postpack
- Is in the
/.gitignore for the /package/README.md path
Why are we doing this?
- Keeps the
README.md visible when someone opens the repository on GitHub
- Properly publishes the
README.md in the tarball
README.md is properly displayed/rendered on npmjs.com and RN Directory
Issue
The RN Directory scoring logic states the package has no README.md while rendering it next to it.
Analysis by @Simek: The scoring logic checks whether a package has a README.md by querying the npm registry API (https://registry.npmjs.org/@maplibre/maplibre-react-native). Which in this case returns "No README data found".
Proposed solution
Use the same endpoints as for rendering the README.md on the client to check, if one is present for the scoring.
See discussions in #2385.
Monorepo setup
Our project @maplibre/maplibre-react-native is a monorepo, the
README.mdis handle like this:/prepackinto the/packagedirectory, removed onpostpack/.gitignorefor the/package/README.mdpathWhy are we doing this?
README.mdvisible when someone opens the repository on GitHubREADME.mdin the tarballREADME.mdis properly displayed/rendered on npmjs.com and RN DirectoryIssue
The RN Directory scoring logic states the package has no
README.mdwhile rendering it next to it.Analysis by @Simek: The scoring logic checks whether a package has a
README.mdby querying the npm registry API (https://registry.npmjs.org/@maplibre/maplibre-react-native). Which in this case returns "No README data found".Proposed solution
Use the same endpoints as for rendering the
README.mdon the client to check, if one is present for the scoring.