fix(docs): Add a note about windows support

Closes #1299
serialport · Aug 11, 2017 · 76b7191 · 76b7191
1 parent e83ec4e
commit 76b7191
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/.docs/README.hbs b/.docs/README.hbs
@@ -87,7 +87,7 @@ In addition to reading the [article mentioned above](http://www.voodootikigod.co
 | Linux / ARM v8¹ |  ☐  |  ☐  |  ☐  |
 | Linux / MIPSel¹ |  ☐  |  ☐  |  ☐  |
 | Linux / PPC64¹  |  ☐  |  ☐  |  ☐  |
-| Windows² / x86  |  ☑  |  ☑  |  ☑  |
+| Windows² / x86  |  ☐  |  ☑  |  ☑  |
 | Windows² / x64  |  ☑  |  ☑  |  ☑  |
 | OSX³ / x64      |  ☑  |  ☑  |  ☑  |
 
@@ -97,6 +97,8 @@ In addition to reading the [article mentioned above](http://www.voodootikigod.co
 
 ³ OSX 10.4 Tiger and above are supported, but our CI tests only 10.9.5 Mavericks with Xcode 6.1.
 
+Until Issue #1221 is closed windows will suffer high cpu reads and writes and will require a `UV_THREADPOOL_SIZE` environment variable to be set to 1 + the number of ports you wish to open at a time. (Defaults to `4` which supports 3 ports).
+
 ## Installation Instructions
 
 For most "standard" use cases (Node v4.x on Mac, Linux, or Windows on a x86 or x64 processor), Node-Serialport will install nice and easy with:

diff --git a/README.md b/README.md
@@ -134,7 +134,7 @@ In addition to reading the [article mentioned above](http://www.voodootikigod.co
 | Linux / ARM v8¹ |  ☐  |  ☐  |  ☐  |
 | Linux / MIPSel¹ |  ☐  |  ☐  |  ☐  |
 | Linux / PPC64¹  |  ☐  |  ☐  |  ☐  |
-| Windows² / x86  |  ☑  |  ☑  |  ☑  |
+| Windows² / x86  |  ☐  |  ☑  |  ☑  |
 | Windows² / x64  |  ☑  |  ☑  |  ☑  |
 | OSX³ / x64      |  ☑  |  ☑  |  ☑  |
 
@@ -144,6 +144,8 @@ In addition to reading the [article mentioned above](http://www.voodootikigod.co
 
 ³ OSX 10.4 Tiger and above are supported, but our CI tests only 10.9.5 Mavericks with Xcode 6.1.
 
+Until Issue #1221 is closed windows will suffer high cpu reads and writes and will require a `UV_THREADPOOL_SIZE` environment variable to be set to 1 + the number of ports you wish to open at a time. (Defaults to `4` which supports 3 ports).
+
 ## Installation Instructions
 
 For most "standard" use cases (Node v4.x on Mac, Linux, or Windows on a x86 or x64 processor), Node-Serialport will install nice and easy with: