From 89ffd61717261e2251f0ac3021ebf22b54fe6af1 Mon Sep 17 00:00:00 2001 From: Juergen Kunz Date: Sun, 9 Nov 2025 11:30:39 +0000 Subject: [PATCH] fix(readme): Update README installation instructions to recommend automated installer script and clarify npm installation --- changelog.md | 7 +++++++ readme.md | 31 +++++++++++-------------------- ts/00_commitinfo_data.ts | 2 +- 3 files changed, 19 insertions(+), 21 deletions(-) diff --git a/changelog.md b/changelog.md index ceaa21a..cf8b9d8 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,12 @@ # Changelog +## 2025-11-09 - 5.1.11 - fix(readme) +Update README installation instructions to recommend automated installer script and clarify npm installation + +- Replace the previous 'Via npm (NEW! - Recommended)' section with a clear 'Automated Installer Script (Recommended)' section and example curl installer. +- Move npm installation instructions into an 'Alternative: Via npm' subsection and clarify that the npm package downloads the appropriate pre-compiled binary for the platform during installation. +- Remove the 'NEW!' badge and streamline notes about binary downloads and installation methods. + ## 2025-10-23 - 5.1.10 - fix(config) Synchronize deno.json version with package.json, tidy formatting, and add local tooling settings diff --git a/readme.md b/readme.md index 00d32ca..7152729 100644 --- a/readme.md +++ b/readme.md @@ -62,26 +62,7 @@ nupst service status ## 📥 Installation -### Via npm (NEW! - Recommended) - -Install NUPST globally using npm: - -```bash -npm install -g @serve.zone/nupst -``` - -**Benefits:** - -- Automatic platform detection and binary download -- Downloads only the binary for your platform (~400-500MB) -- Easy updates via `npm update -g @serve.zone/nupst` -- Version management with npm -- Works with Node.js >=14 - -**Note:** The installation will download the appropriate binary from GitHub releases during the -postinstall step. - -### Automated Installer Script +### Automated Installer Script (Recommended) The installer script handles everything automatically: @@ -136,6 +117,16 @@ chmod +x nupst sudo mv nupst /usr/local/bin/nupst ``` +### Alternative: Via npm + +Alternatively, NUPST can be installed via npm: + +```bash +npm install -g @serve.zone/nupst +``` + +**Note:** This method downloads the appropriate pre-compiled binary for your platform during installation. + ### Verify Installation ```bash diff --git a/ts/00_commitinfo_data.ts b/ts/00_commitinfo_data.ts index 93087d6..cf7f16e 100644 --- a/ts/00_commitinfo_data.ts +++ b/ts/00_commitinfo_data.ts @@ -3,6 +3,6 @@ */ export const commitinfo = { name: '@serve.zone/nupst', - version: '5.1.10', + version: '5.1.11', description: 'Network UPS Shutdown Tool - Monitor SNMP-enabled UPS devices and orchestrate graceful system shutdowns during power emergencies' }