Skip to content

Commit 1c17a88

Browse files
committed
updated README
1 parent 3f63250 commit 1c17a88

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,20 @@ cargo binstall wkg
3636

3737
## Configuration
3838

39+
To quickly set the default registry:
40+
```
41+
wkg config --default-registry {REGISTRY_DOMAIN}
42+
```
43+
44+
For the complete configuration options, you can edit the config file with your default
45+
editor (set with env var `$EDITOR`):
46+
```
47+
wkg config --edit
48+
```
49+
3950
The `wkg` tool and libraries use a configuration file to store settings. This config file is still
4051
subject to change but we will try to keep it backwards compatible as we continue to develop the
41-
tool. This config file is meant to be used by both `wkg` and also any other language specific
52+
tool. This config file is meant to be used by both `wkg` and also any other language-specific
4253
component tooling that wants to fetch from registries. This should allow for a single configuration
4354
file that can be used by all tooling, whether that be `wkg` or some other tool that isn't written in
4455
Rust.
@@ -53,8 +64,7 @@ The default location is `$XDG_CONFIG_HOME/wasm-pkg/config.toml` on unix-like sys
5364
| macOS | `/Users/<username>/Library/Application Support` |
5465
| Windows | `C:\Users\<username>\AppData\Roaming` |
5566

56-
The configuration file is TOML and currently must be edited manually. A future release will include
57-
an interactive CLI for editing the configuration.
67+
The configuration file is TOML and can be edited manually.
5868

5969
Below is an annotated example of a configuration file that shows all the available options.
6070

0 commit comments

Comments
 (0)