Skip to content

Commit 90ebf88

Browse files
wayneparrottMinggang Wang
authored andcommitted
Minimum node version, issue #528 (#529)
* Defined minimum node version, <11.0.0 * added Wayne to contributors list
1 parent 03ef3b4 commit 90ebf88

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Dashing Diademata Patch Release [1](https://github.com/ros2/ros2/releases/tag/re
1717
Crystal Clemmys Patch Release [1](https://github.com/ros2/ros2/releases/tag/release-crystal-20190117)/[2](https://github.com/ros2/ros2/releases/tag/release-crystal-20190214)/[3](https://github.com/ros2/ros2/releases/tag/release-crystal-20190314)/[4](https://github.com/ros2/ros2/releases/tag/release-crystal-20190408)| [0.9.0](https://www.npmjs.com/package/rclnodejs/v/0.9.0) | [crystal-clemmys](https://github.com/RobotWebTools/rclnodejs/tree/crystal-clemmys) |
1818
[Bouncy Bolson](https://github.com/ros2/ros2/releases/tag/release-bouncy) | [0.3.5](https://www.npmjs.com/package/rclnodejs/v/0.3.5) | [bouncy-bolson](https://github.com/RobotWebTools/rclnodejs/tree/bouncy-bolson)
1919

20+
* Verify that you are using a compatible version of node between 6.10 - 10.99: run `node -v` for your node version info.
21+
2022
* Install from npmjs: run `npm i rclnodejs@<version>` to install a specific version.
2123

2224
* Install from GitHub: add `"rclnodejs":"RobotWebTools/rclnodejs#<branch>"` to your `package.json`.
@@ -36,9 +38,9 @@ Alternatively, you can build ROS 2.0 from scratch. Please select the platform yo
3638
### Install `Node.js`
3739

3840
**Notice:**
39-
`rclnodejs` use some new feature of ECMAScript 6, we recommend using the latest LTS Node.js. The lowest LTS Node.js we used to verify the unit tests is `6.10.0`. Your Node.js version should not be lower than this verion.
41+
`rclnodejs` should only be used with node versions between 6.10 - 10.99. The lowest LTS Node.js we used to verify the unit tests is `6.10.0`. And there is a known issue installing rclnodejs with versions of node >= 11.0.
4042

41-
The `Node.js` version we selected is the latest LTS [`Carbon`](https://nodejs.org/download/release/latest-carbon/) (8.x). You can install it:
43+
The `Node.js` version we selected is the LTS [`Carbon`](https://nodejs.org/download/release/latest-carbon/) (8.x). You can install it:
4244

4345
* Download from Node.js offical [website](https://nodejs.org/en/), and install it.
4446
* Use the Node Version Manager ([nvm](https://github.com/creationix/nvm)) to install it.
@@ -178,6 +180,7 @@ Special thanks to the people who contribute.
178180
* [martins-mozeiko](https://github.com/martins-mozeiko)
179181
* [Teo Koon Peng](https://github.com/koonpeng)
180182
* [Alex Mikhalev](https://github.com/amikhalev)
183+
* [Wayne Parrott](https://github.com/wayneparrott)
181184

182185
## License
183186

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,6 @@
5353
"int64-napi": "^1.0.1"
5454
},
5555
"engines": {
56-
"node": ">= 6.10.0"
56+
"node": ">= 6.10.0 <11.0.0"
5757
}
5858
}

0 commit comments

Comments
 (0)