Skip to content

Commit 03897d7

Browse files
CON-282: Document known limitations (#141)
1 parent 8a586ae commit 03897d7

2 files changed

Lines changed: 3 additions & 12 deletions

File tree

docs/getting_started.rst

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,12 @@ Getting Started
66
Installing RTI Connector for JavaScript
77
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88

9-
*RTI Connector for JavaScript* can be installed with npm in two ways:
10-
11-
You can pass the package name:
9+
*RTI Connector for JavaScript* can be installed with npm:
1210

1311
.. code:: bash
1412
1513
$ npm install rticonnextdds-connector
1614
17-
Or the GitHub repository:
18-
19-
.. code:: bash
20-
21-
$ npm install https://www.github.com/rticommunity/rticonnextdds-connector-js.git
22-
23-
In order to access the examples, run npm with the GitHub repository.
24-
2515
npm uses `node-gyp <https://github.com/nodejs/node-gyp>`__ to locally compile some of *Connector*'s
2616
dependencies. node-gyp requires a Python installation and a C++ compiler. Please refer
2717
to the `node-gyp documentation <https://github.com/nodejs/node-gyp#installation>`__

docs/release_notes.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Release Notes
44
Supported Platforms
55
-------------------
66

7-
*Connector* works with Node.js v17-18. It can also be used with
7+
*Connector* works with Node.js v17.0.0-v18.7.0. It can also be used with
88
Node.js versions 10.20.x through 13.x.x, except for versions
99
11.x.x and 12.19.x [#f1]_.
1010

@@ -37,6 +37,7 @@ repository <https://github.com/rticommunity/rticonnextdds-connector>`__.
3737
that version of Node.js.
3838
Node.js v14 and Node.js v16 do not work with *Connector* because one of *Connector's*
3939
dependencies is not compatible with those versions.
40+
Node.js versions greater than v18.7.0 are not currently supported.
4041
4142
Native Windows libraries updated to Visual Studio 2015
4243
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)