aboutsummaryrefslogtreecommitdiff
path: root/packages/bun-npm/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/bun-npm/README.md')
-rw-r--r--packages/bun-npm/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/packages/bun-npm/README.md b/packages/bun-npm/README.md
new file mode 100644
index 000000000..4556f0f4d
--- /dev/null
+++ b/packages/bun-npm/README.md
@@ -0,0 +1,15 @@
+# bun-npm
+
+Scripts that allow Bun to be installed with `npm install`.
+
+### Running
+
+```sh
+bun run npm # build assets for the latest release
+bun run npm -- <release> # build assets for the provided release
+bun run npm -- <release> [dry-run|publish] # build and publish assets to npm
+```
+
+### Credits
+
+- [esbuild](https://github.com/evanw/esbuild), for its npm scripts which this was largely based off of.