Skip to content

Commit 8f204f6

Browse files
committed
Document node-version requirements
1 parent 7327554 commit 8f204f6

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,21 @@ To install, clone this repository into your `$(nodenv root)/plugins` directory.
5151
node >= 6.0
5252

5353
Unlike virtually every other nodenv plugin, node-build-update-defs actually depends on node.
54-
(The scraper runs on node.)
55-
A somewhat recent version of node is required – it is recommended to configure a node-version within the plugin directory itself (substitute your chosen version):
54+
(The scraper itself is written in JavaScript.)
55+
Virtually any modern version of node is sufficient, but one must be available.
56+
Otherwise, you may experience an error like:
5657

57-
cd "$(nodenv root)"/plugins/node-build-update-defs
58-
nodenv local 6.0
58+
> nodenv: version \_ is not installed
59+
60+
It is recommended to configure a node-version for the plugin itself (substitute your chosen version):
61+
62+
echo 6.0 > "$(nodenv root)"/plugins/node-build-update-defs/.node-version
63+
64+
If you have node installed and available in `PATH` _outside_ of nodenv
65+
(by system package manager or Homebrew, for instance)
66+
then the best configuration is to use that for the plugin:
67+
68+
echo system > "$(nodenv root)"/plugins/node-build-update-defs/.node-version
5969

6070
## Usage
6171

0 commit comments

Comments
 (0)