Skip to content

Commit 3134bec

Browse files
authored
[Documentation] Added instructions for NW.js
1 parent 5119e36 commit 3134bec

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ opencv4nodejs
1414
* **[How to install](#how-to-install)**
1515
* **[Usage with Docker](#usage-with-docker)**
1616
* **[Usage with Electron](#usage-with-electron)**
17+
* **[Usage with NW.js](#usage-with-nwjs)**
1718
* **[Quick Start](#quick-start)**
1819
* **[Async API](#async-api)**
1920
* **[Available Modules](#available-modules)**
@@ -137,6 +138,18 @@ const electron = require('electron');
137138
const cv = electron.remote.require('opencv4nodejs');
138139
```
139140

141+
<a name="usage-with-nwjs"></a>
142+
143+
## Usage with NW.js
144+
145+
Any native modules, including opencv4nodejs, must be recompiled to be used with [NW.js](https://nwjs.io/). Instructions on how to do this are available in the **[Use Native Modules] (http://docs.nwjs.io/en/latest/For%20Users/Advanced/Use%20Native%20Node%20Modules/)** section of the the NW.js documentation.
146+
147+
Once recompiled, the module can be installed and required as usual:
148+
149+
``` javascript
150+
const cv = require('opencv4nodejs');
151+
```
152+
140153
<a name="quick-start"></a>
141154

142155
## Quick Start

0 commit comments

Comments
 (0)