Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Put back the README.md file in the npm package #6256

Merged
merged 1 commit into from
Jul 11, 2024

Conversation

piaskowyk
Copy link
Member

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

@tomekzaw tomekzaw changed the title Put back the readme.md file in the NPM package. Put back the README.md file in the npm package Jul 11, 2024
@piaskowyk piaskowyk added this pull request to the merge queue Jul 11, 2024
Merged via the queue into main with commit 7301438 Jul 11, 2024
8 checks passed
@piaskowyk piaskowyk deleted the @piaskowyk/restore-readme branch July 11, 2024 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants