Add README for NPM (#5999)

smith558 · vimtor · web-flow · commit d5a7fba91997 · 2026-02-16T17:17:44.000+01:00
* Add README

* Replace sdk/js/README.md with symlink to root

* Copy root README at publish time instead of symlink

---------

Co-authored-by: vimtor &lt;vn4varro@gmail.com&gt;
diff --git a/sdk/js/scripts/release.ts b/sdk/js/scripts/release.ts
@@ -67,6 +67,7 @@ try {
   }
   console.log(nextPkg);
   await Bun.write("package.json", JSON.stringify(nextPkg, null, 2));
+  await fs.cp("../../README.md", "README.md");
   await $`npm publish --access public --tag ${tag}`;
   if (!snapshot)
     await $`npm dist-tag add ${nextPkg.name}@${nextPkg.version} ion`;

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,7 @@ try {`
`67`	`67`	`}`
`68`	`68`	`console.log(nextPkg);`
`69`	`69`	`await Bun.write("package.json", JSON.stringify(nextPkg, null, 2));`
	`70`	`+ await fs.cp("../../README.md", "README.md");`
`70`	`71`	await $`npm publish --access public --tag ${tag}`;
`71`	`72`	`if (!snapshot)`
`72`	`73`	await $`npm dist-tag add ${nextPkg.name}@${nextPkg.version} ion`;