Skip to content

CON-282: Document known limitations (#141) #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samuelraeburn merged 1 commit into from
Nov 7, 2022
Merged

CON-282: Document known limitations (#141) #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions docs/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,12 @@ Getting Started
Installing RTI Connector for JavaScript
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*RTI Connector for JavaScript* can be installed with npm in two ways:

You can pass the package name:
*RTI Connector for JavaScript* can be installed with npm:

.. code:: bash

$ npm install rticonnextdds-connector

Or the GitHub repository:

.. code:: bash

$ npm install https://www.github.com/rticommunity/rticonnextdds-connector-js.git

In order to access the examples, run npm with the GitHub repository.

npm uses `node-gyp <https://github.com/nodejs/node-gyp>`__ to locally compile some of *Connector*'s
dependencies. node-gyp requires a Python installation and a C++ compiler. Please refer
to the `node-gyp documentation <https://github.com/nodejs/node-gyp#installation>`__
Expand Down
3 changes: 2 additions & 1 deletion docs/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Release Notes
Supported Platforms
-------------------

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

Expand Down Expand Up @@ -37,6 +37,7 @@ repository <https://github.com/rticommunity/rticonnextdds-connector>`__.
that version of Node.js.
Node.js v14 and Node.js v16 do not work with *Connector* because one of *Connector's*
dependencies is not compatible with those versions.
Node.js versions greater than v18.7.0 are not currently supported.

Version 1.2.2
-----------------
Expand Down
⚡