docs: refine the install section in README

This commit is contained in:
Augusto Moura 2021-03-15 13:00:02 -03:00
parent 3f4950047b
commit b23bbd9857

View File

@ -23,16 +23,10 @@ Node.js plugin for [asdf](https://github.com/asdf-vm/asdf) version manager
## Install
Install the plugin:
After installing [asdf](https://github.com/asdf-vm/asdf), install the plugin by running:
```bash
asdf plugin-add nodejs https://github.com/asdf-vm/asdf-nodejs.git
```
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:
```bash
bash -c '${ASDF_DATA_DIR:=$HOME/.asdf}/plugins/nodejs/bin/import-previous-release-team-keyring'
asdf plugin-add nodejs
```
## Use
@ -66,6 +60,14 @@ express
You can specify a non-default location of this file by setting a `ASDF_NPM_DEFAULT_PACKAGES_FILE` variable.
## Problems with OpenPGP signatures in older versions
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:
```bash
bash -c '${ASDF_DATA_DIR:=$HOME/.asdf}/plugins/nodejs/bin/import-previous-release-team-keyring'
```
## Temporarily disable reshimming
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`.