aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jarred Sumner <jarred@jarredsumner.com> 2022-02-12 05:28:52 -0800
committerGravatar Jarred Sumner <jarred@jarredsumner.com> 2022-02-12 05:28:52 -0800
commit3141b928f804c2bd735635293c94b7e4c45a1912 (patch)
tree528fd9936269ad1082f0819cd56149e4da5850c4
parent614d810ef4ba7da59a80772ae0d044062befe08c (diff)
downloadbun-3141b928f804c2bd735635293c94b7e4c45a1912.tar.gz
bun-3141b928f804c2bd735635293c94b7e4c45a1912.tar.zst
bun-3141b928f804c2bd735635293c94b7e4c45a1912.zip
Update README.md
Diffstat (limited to '')
-rw-r--r--README.md9
1 files changed, 3 insertions, 6 deletions
diff --git a/README.md b/README.md
index 30994f544..da1ca5f68 100644
--- a/README.md
+++ b/README.md
@@ -657,14 +657,11 @@ bun install can be configured via `bunfig.toml`, environment variables, and CLI
Configuring with `bunfig.toml` is optional. bun tries to be zero configuration in general, but that's not always possible.
```toml
-# Here's how to use scoped packages with bun install
+# Using scoped packages with bun install
[install.scopes]
# The key is the scope name
# The value can be a URL string or an object
-# It can be a string or an object
-# The registry object's url is optional
-# If omitted, the default registry is used
-"@mybigcompany" = { token = "123456", url = "https://registry.mybigcompany.com" }
+"@mybigcompany" = { token = "123456", url = "https://registry.mybigcompany.com" # If omitted, the default registry is used }
# The "@" is optional
mybigcompany2 = { token = "123456" }
@@ -672,7 +669,7 @@ mybigcompany2 = { token = "123456" }
# Environment variables can be referenced as a string that starts with $ and it will be replaced
mybigcompany3 = { token = "$npm_config_token" }
-# Setting username and password pass it along as a Basic Auth header by taking base64("username:password")
+# Setting username and password turns it into a Basic Auth header by taking base64("username:password")
mybigcompany4 = { username = "myusername", password = "$npm_config_password", url = "https://registry.yarnpkg.com/" }
# You can set username and password for a registry URL: