Skip to content

chore(cli): Add README to the npm package#190

Merged
misonijnik merged 1 commit into
mainfrom
misonijnik/npm-readme
Jun 17, 2026
Merged

chore(cli): Add README to the npm package#190
misonijnik merged 1 commit into
mainfrom
misonijnik/npm-readme

Conversation

@misonijnik

Copy link
Copy Markdown
Member

No description provided.

The @seqra/opentaint npm package shipped with no README, so the package
page rendered empty. Add a package-focused README mirroring the project's
house style (SVG logo, badges, demo) and wire it into the distribution:

- build-npm-packages.sh copies README.md into the assembled main package
- package.tmpl.json lists README.md in files (explicit; npm auto-includes)
- build smoke test asserts the README ships in the main package

Images use absolute raw.githubusercontent.com URLs so the logo and demo
render both on npmjs.com and when the file is viewed on GitHub at its
cli/npm path (repo-root-relative paths would 404 on the latter).
@misonijnik misonijnik force-pushed the misonijnik/npm-readme branch from 4cca4b6 to b710d7b Compare June 16, 2026 15:15
@misonijnik misonijnik changed the title docs(cli): Add README to the npm package chore(docs): Add README to the npm package Jun 16, 2026
@misonijnik misonijnik changed the title chore(docs): Add README to the npm package chore(cli): Add README to the npm package Jun 17, 2026
@misonijnik misonijnik marked this pull request as ready for review June 17, 2026 15:17
@misonijnik misonijnik merged commit 6558da1 into main Jun 17, 2026
16 of 18 checks passed
@misonijnik misonijnik deleted the misonijnik/npm-readme branch June 17, 2026 15:17
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