Skip to content

πŸ› include README.md in published npm package#3

Open
cowboyd wants to merge 1 commit intomainfrom
npm-readme
Open

πŸ› include README.md in published npm package#3
cowboyd wants to merge 1 commit intomainfrom
npm-readme

Conversation

@cowboyd
Copy link
Copy Markdown
Member

@cowboyd cowboyd commented Apr 28, 2026

Motivation

The @frontside/freedom npm package was being published without a README, so npmjs.com showed no documentation on the package page.

Approach

dnt's build() doesn't copy README.md into the npm output by default. Add a postBuild hook that copies README.md from the repo root into build/npm/ so it ships with the published package.

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.

1 participant