Skip to content

Commit b38dda3

Browse files
Merge pull request #214 from augustobmoura/feature/add-asdf-vm-install-docs
Refine the install section in README
2 parents d56626a + b23bbd9 commit b38dda3

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,10 @@ Node.js plugin for [asdf](https://github.com/asdf-vm/asdf) version manager
2323

2424
## Install
2525

26-
Install the plugin:
26+
After installing [asdf](https://github.com/asdf-vm/asdf), install the plugin by running:
2727

2828
```bash
29-
asdf plugin-add nodejs https://github.com/asdf-vm/asdf-nodejs.git
30-
```
31-
32-
The plugin now automatically imports the NodeJS release team's OpenPGP keys. If you are trying to install a previous release and facing any issue about verification, import the Node.js previous release team's OpenPGP keys to main keyring:
33-
34-
```bash
35-
bash -c '${ASDF_DATA_DIR:=$HOME/.asdf}/plugins/nodejs/bin/import-previous-release-team-keyring'
29+
asdf plugin-add nodejs
3630
```
3731

3832
## Use
@@ -66,6 +60,14 @@ express
6660

6761
You can specify a non-default location of this file by setting a `ASDF_NPM_DEFAULT_PACKAGES_FILE` variable.
6862

63+
## Problems with OpenPGP signatures in older versions
64+
65+
The plugin automatically imports the NodeJS release team's OpenPGP keys. If you are trying to install a previous release and facing any issue about verification, import the Node.js previous release team's OpenPGP keys to main keyring:
66+
67+
```bash
68+
bash -c '${ASDF_DATA_DIR:=$HOME/.asdf}/plugins/nodejs/bin/import-previous-release-team-keyring'
69+
```
70+
6971
## Temporarily disable reshimming
7072

7173
To avoid a slowdown when installing large packages (see https://github.com/asdf-vm/asdf-nodejs/issues/46), you can `ASDF_SKIP_RESHIM=1 npm i -g <package>` and reshim after installing all packages using `asdf reshim nodejs`.

0 commit comments

Comments
 (0)