aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jarred Sumner <709451+Jarred-Sumner@users.noreply.github.com> 2022-10-15 00:30:19 -0700
committerGravatar Jarred Sumner <709451+Jarred-Sumner@users.noreply.github.com> 2022-10-15 00:30:19 -0700
commitdd84681d30b11f57fd090c6787f233666fda277a (patch)
tree07860d3e5fdc654fb1ba3cf3a5100aeb558708b9
parent0a1fca5d7d7806b8c9b00ab43f76e5f52148d01b (diff)
downloadbun-dd84681d30b11f57fd090c6787f233666fda277a.tar.gz
bun-dd84681d30b11f57fd090c6787f233666fda277a.tar.zst
bun-dd84681d30b11f57fd090c6787f233666fda277a.zip
Update README.md
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 8bbcbb829..17d9ea71f 100644
--- a/README.md
+++ b/README.md
@@ -1544,10 +1544,11 @@ Warning: **This will always delete everything in destination-dir**.
The `bun-create` section of `package.json` is automatically removed from the `package.json` on disk. This lets you add create-only steps without waiting for an extra package to install.
-There are currently two options:
+There are currently three options:
- `postinstall`
- `preinstall`
+- `start` (customize the displayed start command)
They can be an array of strings or one string. An array of steps will be executed in order.
@@ -1570,11 +1571,13 @@ Here is an example:
"typescript": "^4.3.5"
},
"bun-create": {
- "postinstall": ["bun bun --use next"]
+ "postinstall": ["bun bun --use next"],
+ "start": "bun run echo 'Hello world!'"
}
}
```
+
By default, all commands run inside the environment exposed by the auto-detected npm client. This incurs a significant performance penalty, something like 150ms spent waiting for the npm client to start on each invocation.
Any command that starts with `"bun "` will be run without npm, relying on the first `bun` binary in `$PATH`.