fix(readme): Update README installation instructions to recommend automated installer script and clarify npm installation
This commit is contained in:
@@ -1,5 +1,12 @@
|
|||||||
# Changelog
|
# 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)
|
## 2025-10-23 - 5.1.10 - fix(config)
|
||||||
Synchronize deno.json version with package.json, tidy formatting, and add local tooling settings
|
Synchronize deno.json version with package.json, tidy formatting, and add local tooling settings
|
||||||
|
|
||||||
|
|||||||
31
readme.md
31
readme.md
@@ -62,26 +62,7 @@ nupst service status
|
|||||||
|
|
||||||
## 📥 Installation
|
## 📥 Installation
|
||||||
|
|
||||||
### Via npm (NEW! - Recommended)
|
### Automated Installer Script (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
|
|
||||||
|
|
||||||
The installer script handles everything automatically:
|
The installer script handles everything automatically:
|
||||||
|
|
||||||
@@ -136,6 +117,16 @@ chmod +x nupst
|
|||||||
sudo mv nupst /usr/local/bin/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
|
### Verify Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@serve.zone/nupst',
|
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'
|
description: 'Network UPS Shutdown Tool - Monitor SNMP-enabled UPS devices and orchestrate graceful system shutdowns during power emergencies'
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user