Put back the README.md file in the npm package#6256
Merged
Conversation
tomekzaw
approved these changes
Jul 11, 2024
tomekzaw
changed the title
This was referenced Sep 24, 2024
This was referenced Sep 25, 2024
This was referenced Oct 1, 2024
This was referenced Oct 3, 2024
This was referenced Oct 4, 2024
r0h0gg6
pushed a commit
to r0h0gg6/react-native-reanimated
that referenced
this pull request
Jul 28, 2025
## Summary This PR adds the `README.md` file back to the NPM package. After migration to a monorepo, the `README.md` file's location was changed to the parent directory. Unfortunately, you can't include a file from the parent directory in an npm package, and symlinks don't work for this either. ## Test plan run `npm pack` and check if README.md is inside
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
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.
Summary
This PR adds the
README.mdfile back to the NPM package. After migration to a monorepo, theREADME.mdfile's location was changed to the parent directory. Unfortunately, you can't include a file from the parent directory in an npm package, and symlinks don't work for this either.Test plan
run
npm packand check if README.md is inside