sync-request-curl - npm Package Compare versions

Comparing version 1.5.6 to 1.5.7

package.json

@@ -7,3 +7,3 @@ {
   },
-  "version": "1.5.6",
+  "version": "1.5.7",
   "files": [
@@ -10,0 +10,0 @@ "dist"

README.md

@@ -36,5 +36,6 @@ # sync-request-curl
 - [3. License](#3-license)
-- [4. Windows/MacOS](#4-windowsmacos)
+- [4. Compatibility](#4-compatibility)
   - [4.1. Windows](#41-windows)
   - [4.2. MacOS](#42-macos)
+  - [4.3. Linux](#43-linux)
 - [5. Caveats](#5-caveats)
@@ -48,3 +49,3 @@
 
-Please also refer to the [Windows/MacOS](#4-windowsmacos) section for known issues and workarounds.
+Please also refer to the [compatibility](#4-compatibility) section for known issues and workarounds.
 
@@ -199,3 +200,3 @@ ## 2. Usage
     <td>
-      Times out if no response is returned within the given number of milliseconds
+      Times out if no response is returned within the given number of milliseconds.
     </td>
@@ -208,3 +209,3 @@ <td><pre>2000</pre></td>
     <td>
-      Sets whether redirects (status code 302) should be followed automatically
+      Sets whether redirects (status code 302) should be followed automatically.
     </td>
@@ -236,3 +237,3 @@ <td><pre>false</pre></td>
     <td>insecure</td>
-    <td> Set to false to send insecure requests. This can be useful on Windows which can sometimes have SSL issues (Curlcode 60).</td>
+    <td> Set to false to send insecure requests. This can be useful on Windows which can sometimes have SSL issues (Libcurl code 60).</td>
     <td><pre>true</pre></td>
@@ -335,10 +336,10 @@ <td><code>false</code></td>
 
-<br/>
+## 4. Compatibility
 
-## 4. Windows/MacOS
-
 ### 4.1. Windows
 
-Your requests may unexpectedly fail with a [Libcurl Error](https://curl.se/libcurl/c/libcurl-errors.html) (code 60, CURLE_PEER_FAILED_VERIFICATION) when using NodeJS natively on Windows.
+For installation issues, be sure to review the [Windows Build Requirements](https://github.com/JCMais/node-libcurl#building-on-windows) from node-libcurl's documentation.
 
+In addition, your requests may unexpectedly fail with a [Libcurl Error](https://curl.se/libcurl/c/libcurl-errors.html) (code 60, CURLE_PEER_FAILED_VERIFICATION) when using NodeJS natively on Windows.
+
 The reason is covered in the below resources:
@@ -360,4 +361,12 @@ - https://github.com/JCMais/node-libcurl/issues/301
 
-Otherwise, we recommend uninstalling this library and using [sync-request](https://github.com/JCMais/node-libcurl/issues/382) instead.
+and carefully reviewing the [MacOS Build Requirements](https://github.com/JCMais/node-libcurl#building-on-macos) from node-libcurl's documentation. Otherwise, we recommend uninstalling this library and installing [sync-request](https://github.com/JCMais/node-libcurl/issues/382).
 
+### 4.3. Linux
+
+In rare cases, the build for distributions such as Debian or Ubuntu may fail. This is attributed to missing dependencies such as Python or Libcurl. Below are some related issues:
+- https://github.com/JCMais/node-libcurl/issues/374
+- https://github.com/JCMais/node-libcurl/issues/376
+
+Be sure to also check the [Linux Build Requirements](https://github.com/JCMais/node-libcurl#building-on-linux) from node-libcurl's documentation.
+
 ## 5. Caveats
@@ -364,0 +373,0 @@

No alert changes

Improved metrics

Total package byte prevSize

42155

increased by1.95%

Number of lines in readme file

372

increased by2.48%

No dependency changes