aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Gavin John <gavinnjohn@gmail.com> 2023-10-04 23:29:54 -0500
committerGravatar GitHub <noreply@github.com> 2023-10-04 21:29:54 -0700
commitc5c7934ebc28d27342b42f40b7834bc35dd24aaf (patch)
tree0676673031d69b1cab44d595b306487e25db1316
parentb0ffe686757d5b51744e1b1af41afbc16581ca1b (diff)
downloadbun-c5c7934ebc28d27342b42f40b7834bc35dd24aaf.tar.gz
bun-c5c7934ebc28d27342b42f40b7834bc35dd24aaf.tar.zst
bun-c5c7934ebc28d27342b42f40b7834bc35dd24aaf.zip
Update `preload` documentation to make applicability to plugins more obvious (#6298)
-rw-r--r--docs/runtime/bunfig.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/runtime/bunfig.md b/docs/runtime/bunfig.md
index 52ffcec11..83f66b1b1 100644
--- a/docs/runtime/bunfig.md
+++ b/docs/runtime/bunfig.md
@@ -19,11 +19,11 @@ Bun's runtime behavior is configured using top-level fields in the `bunfig.toml`
### `preload`
-An array of scripts to execute before running a file or script. This is useful for registering plugins.
+An array of scripts/plugins to execute before running a file or script.
```toml
-# scripts to run before `bun run`ning a file or script
-# useful for registering plugins
+# scripts to run before `bun run`-ing a file or script
+# register plugins by adding them to this list
preload = ["./preload.ts"]
```