Update the (ngx-)web-component READMEs to the current reality, and include them in the published packages on npmjs.
Fixes?
Fixes #296
Feedback sought?
Particularly the contents of the readmes, to make sure they're accurate right now as to how the web-component works.
Priority?
medium high
Tests added?
How to test?
I have manually tested by locally running the steps in release.yml (with npm publish --dry-run) and making sure the README.md files get included.
npx nx build web-component
npx nx build ngx-web-component
cd dist/packages/web-component
npm publish --dry-run
cd ../ngx-web-component
npm publish --dry-run
Confidence?
High for the patch to include the README, medium for the actual contents of the READMEs
I have tested the link [@readalongs/web-component](../web-component) in ngx-web-component/README.md on github, where it works as intended, I hope it will work the sime on npmjs.
Version change?
patch bump: There is currently no README on our packages on npmjs and that's not good. The official process to publish the READMEs in this situation is to publish a patch bump.
PR Goal?
Update the (ngx-)web-component READMEs to the current reality, and include them in the published packages on npmjs.
Fixes?
Fixes #296
Feedback sought?
Particularly the contents of the readmes, to make sure they're accurate right now as to how the web-component works.
Priority?
medium high
Tests added?
How to test?
I have manually tested by locally running the steps in
release.yml
(withnpm publish --dry-run
) and making sure the README.md files get included.Confidence?
High for the patch to include the README, medium for the actual contents of the READMEs
I have tested the link
[@readalongs/web-component](../web-component)
inngx-web-component/README.md
on github, where it works as intended, I hope it will work the sime on npmjs.Version change?
patch bump: There is currently no README on our packages on npmjs and that's not good. The official process to publish the READMEs in this situation is to publish a patch bump.