simple-open-ssl

Author: FirstTimeEZ

README.md

@@ -2,24 +2,31 @@
 
 # Simple OpenSSL for Javascript
 
-Execute `OpenSSL` commands directly from JavaScript. Provides a simple, cross-platform interface for cryptographic operations, certificate management, and security tasks.
+Execute `OpenSSL` commands directly from `JavaScript`. 
+
+Provides a simple, cross-platform interface for cryptographic operations, certificate management, and security tasks.
+
+#### Usage:
 
 ```javascript
 import { runCommandSync } from 'simple-open-ssl';
 
 const standardOutput = runCommandSync(`x509 -in certificate.pem -enddate -noout`);
 ```
 
-Windows:
+#### Windows:
+
+Uses the included packaged version
 
 ```
-Uses included packaged version
 OpenSSL 3.2.3 3 Sep 2024 (Library: OpenSSL 3.2.3 3 Sep 2024)
 ```
 
-Linux/Other: 
+#### Linux/Other: 
+
+Uses the local version of `OpenSSl` that is already installed
+
 ```
-Uses local version which should be preinstalled
 manual install required if its not
 Debian: sudo apt install openssl
 RHEL:   sudo yum install openssl
@@ -28,11 +35,18 @@ MacOS:  brew install openssl
 
 ---------------------
 
-### runCommandSync
+# Exports
 
-```
+### `runCommandSync`
+
+Executes an OpenSSL command synchronously.
+
+<details>
+<summary><b>Show jsdoc</b></summary>
+
+```javascript
 /**
- * Executes an OpenSSL command synchronously across different platforms.
+ * Executes an OpenSSL command synchronously.
  *
  * @description
  * This function runs OpenSSL commands with platform-specific handling:
@@ -48,4 +62,6 @@ MacOS:  brew install openssl
  * @returns {string|undefined} The standard output from the executed command, or `undefined` if the command execution fails.
  */
 export function runCommandSync(opensslCommand, execOptions = { encoding: 'utf-8' }) { /* */ }
-```
+```
+
+</details>

open-ssl.js

@@ -8,7 +8,7 @@ const __plaformWindows = platform() === 'win32';
 const __opensslPath = join(dirname(fileURLToPath(import.meta.url)), "openssl", "bin", "openssl.exe");
 
 /**
- * Executes an OpenSSL command synchronously across different platforms.
+ * Executes an OpenSSL command synchronously.
  *
  * @description
  * This function runs OpenSSL commands with platform-specific handling:

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "simple-open-ssl",
   "author": "FirstTimeEZ",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Execute OpenSSL commands directly from JavaScript. Provides a simple, cross-platform interface for cryptographic operations, certificate management, and security tasks.",
   "main": "open-ssl.js",
   "type": "module",
@@ -61,5 +61,5 @@
     "type": "git",
     "url": "git+https://github.com/FirstTimeEZ/simple-open-ssl.git"
   },
-  "homepage": "https://github.com/FirstTimeEZ/simple-open-ssl"
+  "homepage": "https://github.com/FirstTimeEZ/server-ssl"
 }