Merge pull request #153 from nathanielvarona/documentation-generic-na…

…me-for-usage-inputs Generic Name for Usage Inputs
nathanielvarona · May 2, 2024 · a4ec065 · a4ec065
2 parents 23998a2 + b516e98
commit a4ec065
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -44,16 +44,17 @@ The configuration is declarative and relatively simple to use.
 ### Inputs
 
 ```yaml
-uses: nathanielvarona/pritunl-client-github-action@v1
-with:
-  profile-file: ''  # REQUIRED: Pritunl Profile File (Base64 text format)
-  profile-pin: ''  # OPTIONAL: Profile Pin (Numerical values, default: no pin)
-  profile-server: ''  # OPTIONAL: Profile Server (Single string or comma-separated for multiple names, default: first or only server in the profile)
-  vpn-mode: ''  # OPTIONAL: VPN Connection Mode ( choices: 'ovpn', 'openvpn', 'OpenVPN', 'wg', 'wireguard', 'WireGuard', default: 'ovpn')
-  client-version: ''  # OPTIONAL: Pritunl Client Version (Numerical dot-separated identifiers, default: latest version from Package Manager)
-  start-connection: ''  # OPTIONAL: Start the Connection (Boolean, default: true)
-  ready-profile-timeout: ''  # OPTIONAL: Ready Profile Timeout (Natural Numbers, unit of time in seconds, default: 3)
-  established-connection-timeout: ''  # OPTIONAL: Established Connection Timeout (Natural Numbers, unit of time in seconds, default: 30)
+- name: Pritunl Client GitHub Action
+  uses: nathanielvarona/pritunl-client-github-action@v1
+  with:
+    profile-file: '' # REQUIRED: Pritunl Profile File (Base64 text format)
+    profile-pin: '' # OPTIONAL: Profile Pin (Numerical values, default: no pin)
+    profile-server: '' # OPTIONAL: Profile Server (Single string or comma-separated for multiple names, default: first or only server in the profile)
+    vpn-mode: '' # OPTIONAL: VPN Connection Mode ( choices: 'ovpn', 'openvpn', 'OpenVPN', 'wg', 'wireguard', 'WireGuard', default: 'ovpn')
+    client-version: '' # OPTIONAL: Pritunl Client Version (Numerical dot-separated identifiers, default: latest version from Package Manager)
+    start-connection: '' # OPTIONAL: Start the Connection (Boolean, default: true)
+    ready-profile-timeout: '' # OPTIONAL: Ready Profile Timeout (Natural Numbers, unit of time in seconds, default: 3)
+    established-connection-timeout: '' # OPTIONAL: Established Connection Timeout (Natural Numbers, unit of time in seconds, default: 30)
 ```
 
 > [!IMPORTANT]

diff --git a/pritunl-client.sh b/pritunl-client.sh
@@ -22,7 +22,7 @@ PRITUNL_READY_PROFILE_TIMEOUT="${PRITUNL_READY_PROFILE_TIMEOUT:-}"  # Ready Prof
 PRITUNL_ESTABLISHED_CONNECTION_TIMEOUT="${PRITUNL_ESTABLISHED_CONNECTION_TIMEOUT:-}"  # Established Connection Timeout
 # ---------------------------------------------------------------
 
-# ASCII Art and Color Codes
+# Emoji Unicode and Color Codes
 TTY_EMOJI_ROCKET='\xf0\x9f\x9a\x80'  # Rocket emoji for visual feedback
 TTY_RED_NORMAL='\033[0;31m'  # Normal red color
 TTY_RED_BOLD='\033[1;31m'  # Bold red color