aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-11-05 02:52:16 -0700
committerGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-11-05 02:52:16 -0700
commit673b755987388798d821c428c48dbcb272a85364 (patch)
treeda64541c384cd4ee37c051dc69589c976ef7f6c4
parent3d6fab6e49dcce016fb0e70b3ddc54b4eedda3ca (diff)
downloadbun-673b755987388798d821c428c48dbcb272a85364.tar.gz
bun-673b755987388798d821c428c48dbcb272a85364.tar.zst
bun-673b755987388798d821c428c48dbcb272a85364.zip
Update README.md
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index df340c7b6..b5b2fc46e 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,8 @@ Assuming a package.json with a `"clean"` command in `"scripts"`:
}
```
+Note: `bun run` is not an npm client, it won't install packages.
+
## Using Bun with Next.js
To create a new Next.js app with Bun:
@@ -843,6 +845,12 @@ Is generated like this:
The implementation details of this module ID hash will vary between versions of Bun. The important part is the metadata contains the module IDs, the package paths, and the package hashes so it shouldn't really matter in practice if other tooling wants to make use of any of this.
+### `bun completions`
+
+This command installs completions for `zsh` and/or `fish`. It's run automatically on every `bun upgrade` and on install. It reads from `$SHELL` to determine which shell to install for. It tries several common shell completion directories for your shell and OS.
+
+If you want to copy the completions manually, run `bun completions > path-to-file`. If you know the completions directory to install them to, run `bun completions /path/to/directory`.
+
### Environment variables
- `GOMAXPROCS`: For `bun bun`, this sets the maximum number of threads to use. If you're experiencing an issue with `bun bun`, try setting `GOMAXPROCS=1` to force bun to run single-threaded