@openfin/node-adapter 34.78.50 → 34.78.52

package/README.md

@@ -1,8 +1,8 @@
 # OpenFin Node.js adapter
 
-Allows the use of the OpenFin API from node.js. Please note the launch and connect methods are specific to a node environment.
+Allows the use of the OpenFin API from node.js. Please note that the `launch` and `connect` methods are specific to a node environment.
 
-## Requirements
+## Prerequisites
 
 -   Node.js 16 or greater
 
@@ -12,11 +12,11 @@ Allows the use of the OpenFin API from node.js. Please note the launch and conne
 
 `connect` can be used to establish a connection to an OpenFin runtime from node.
 
-A uuid must be provided to identify the connection. Multiple connections will require distinct uuids.
+A `uuid` value must be provided to identify the connection. Multiple connections require distinct `uuid` values.
 
-A runtime version or manifest url must also be specified.
+A Runtime version or manifest URL must also be specified.
 
-Note - `connect` will instantiate a runtime instance if one does not exist for the given configuration. If the runtime is already running, connect will simply establish a new connection.
+> Note:  `connect` instantiates a Runtime instance if one does not exist for the given configuration. If a Runtime is already running, `connect` simply establishes a new connection.
 
 ### Connecting via Runtime Version
 
@@ -34,7 +34,7 @@ import { connect } from '@openfin/node-adapter';
 })();
 ```
 
-### Connecting via Manifest Url
+### Connecting via Manifest URL 
 
 ```javascript
 import { connect } from '@openfin/node-adapter';
@@ -53,9 +53,9 @@ import { connect } from '@openfin/node-adapter';
 
 Unlike `connect`, `launch` starts an OpenFin application if not running and returns a port number instead of a `fin` object.
 
-This can be provided to connect to create a `fin` object for the runtime that has been created on the specific port.
+This port number can be provided to connect to create a `fin` object for the Runtime that has been created on the specific port.
 
-`launch` can be called multiple times for a given application, however launches for an application that is already running will result in a [run-requested](https://developer.openfin.co/jsdocs/stable/tutorial-application.addEventListener.html#run-requested) event being triggered instead of a relaunch. If the application is an OpenFin platform, this will result in the layout windows reloading.
+`launch` can be called multiple times for a given application; however launches for an application that is already running result in a [run-requested](https://developer.openfin.co/jsdocs/stable/tutorial-application.addEventListener.html#run-requested) event being triggered instead of a relaunch. If the application is an OpenFin platform, this scenario results in the layout windows reloading.
 
 ### Launching and Connecting via Port
 
@@ -80,9 +80,9 @@ import { launch, connect } from '@openfin/node-adapter';
 
 ## Types
 
-`@openfin/node-adapter` comes bundled with its own types types.
+`@openfin/node-adapter` comes bundled with its own types.
 
-If you wish to explicitly reference OpenFin types, the `OpenFin` namespace export may be used as follows:
+If you wish to explicitly reference OpenFin types, the `OpenFin` namespace export can be used as follows:
 
 ### Type Usage Example
 
@@ -105,7 +105,7 @@ import OpenFin, { connect } from '@openfin/node-adapter';
 
 For users of the `connect` and `launch` functions in `openfin-adapter`, no changes are necessary, other than updating the dependency name.
 
-If using the exported types from `openfin-adapter`, an `OpenFin` export has been created that encapsualates them.
+If you are using the exported types from `openfin-adapter`, you can now use the `OpenFin` export that encapsualates them.
 
 ### Before