[Doc] Updates for os support and usage

wilix-team · Jun 12, 2021 · 1b414d5 · 1b414d5
1 parent 8986332
commit 1b414d5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/docs/os-support.md b/docs/os-support.md
@@ -4,7 +4,7 @@ Every iohook version is built on Linux, macOS and Windows. It has been tested on
 
 - Ubuntu 20.04
 - macOS Big Sur 11.0.1 (Intel only for now) and older
-- Windows 10 x64/x32
+- Windows 10 x64/x32. Requires `Visual C++ Runtime Redistributable` installed on machine either in development or production. Make sure to inform users.
 
 ::: tip INFO
 Recent versions of NodeJS are not available for 32bit architecture on Linux after Node 13, so we decided to drop support for 32bit Linux prebuilt after v0.7.3.

diff --git a/docs/usage.md b/docs/usage.md
@@ -1,10 +1,12 @@
 # Usage
 
-## Usage with Electron
+## Electron 
 
 Before installing this module, you will need to set a runtime version in your `package.json`.
 
-When developing with webpack, you will need the Node.js runtime. In production, your Electron app will need the Electron version.
+When developing with webpack, you will need the Node.js runtime.
+
+In production, your Electron app will need the Electron version.
 
 Checkout your ABI for [node.js](https://nodejs.org/en/download/releases/) or [electron](https://www.npmjs.com/package/electron-abi). The example below uses Node.js v12.X and Electron v11.X.
 
@@ -50,7 +52,7 @@ Or you can specify targets as objects:
 if you use a two-package.json structure, add this to application package.json.
 :::
 
-## Usage in a generic Node application
+## Generic Node application
 
 Here is a simple example :
 
@@ -68,6 +70,9 @@ ioHook.start();
 
 // Alternatively, pass true to start in DEBUG mode.
 ioHook.start(true);
+
+// False to disable DEBUG. Cleaner terminal output.
+ioHook.start(false);
 ```
 
 ## Available events