chore: add README files to packages bundle, fix metadata #87
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Owner
|
Ah thank you so much! I just did a release before seeing your PR, so it'll land in the next one. Really cool! :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
Both packages from monorepo lack README files in npm registry:
How
Updated
realeas.shscript to copy over README.md from repo root before packing, and remove it afterwards.In the process I have also updated the packages metadata in
package.jsonfiles, which include proper description and correct links forreact-native-nitro-web-image.It would be nice to symlink root README.md in packages directory for more convenient GitHub experience, but symlinked files are not included in the bundle when running
npm packwhich means that symlinks would need to be deleted and restored insiderealeas.shscript, sincecpdoes not overwrite them.Was not sure if you want to increase the complexity, let me know what's your take and I can alter the PR accordingly.
Preview