@lvnt/release-radar 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -19
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -45,6 +45,36 @@ Built for environments with limited internet access (e.g., intranet) where manua
|
|
|
45
45
|
|
|
46
46
|
## Installation
|
|
47
47
|
|
|
48
|
+
### From npm (recommended)
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
# Install globally
|
|
52
|
+
npm install -g @lvnt/release-radar
|
|
53
|
+
|
|
54
|
+
# Create a directory for config and data
|
|
55
|
+
mkdir ~/release-radar && cd ~/release-radar
|
|
56
|
+
|
|
57
|
+
# First run creates config files (.env and config/tools.json)
|
|
58
|
+
release-radar
|
|
59
|
+
|
|
60
|
+
# Edit .env with your Telegram credentials
|
|
61
|
+
nano .env
|
|
62
|
+
|
|
63
|
+
# Run again
|
|
64
|
+
release-radar
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### With pm2 (recommended for production)
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
cd ~/release-radar
|
|
71
|
+
pm2 start release-radar --name release-radar
|
|
72
|
+
pm2 save
|
|
73
|
+
pm2 startup # Enable auto-start on boot
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### From source (for development)
|
|
77
|
+
|
|
48
78
|
```bash
|
|
49
79
|
# Clone the repository
|
|
50
80
|
git clone https://github.com/lvntbkdmr/release-radar.git
|
|
@@ -57,8 +87,9 @@ npm install
|
|
|
57
87
|
cp .env.example .env
|
|
58
88
|
# Edit .env with your Telegram credentials
|
|
59
89
|
|
|
60
|
-
# Build
|
|
90
|
+
# Build and run
|
|
61
91
|
npm run build
|
|
92
|
+
npm start
|
|
62
93
|
```
|
|
63
94
|
|
|
64
95
|
## Configuration
|
|
@@ -100,24 +131,6 @@ Edit `config/tools.json` to add/remove tools:
|
|
|
100
131
|
|
|
101
132
|
## Usage
|
|
102
133
|
|
|
103
|
-
### Development
|
|
104
|
-
```bash
|
|
105
|
-
npm run dev
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
### Production
|
|
109
|
-
```bash
|
|
110
|
-
npm run build
|
|
111
|
-
npm start
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### With pm2 (recommended)
|
|
115
|
-
```bash
|
|
116
|
-
npm install -g pm2
|
|
117
|
-
pm2 start npm --name "release-radar" -- start
|
|
118
|
-
pm2 save
|
|
119
|
-
```
|
|
120
|
-
|
|
121
134
|
### Telegram Commands
|
|
122
135
|
|
|
123
136
|
| Command | Description |
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lvnt/release-radar",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Monitor tool versions and notify via Telegram when updates are detected",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"bin": {
|
|
7
|
-
"release-radar": "
|
|
7
|
+
"release-radar": "bin/release-radar.js"
|
|
8
8
|
},
|
|
9
9
|
"type": "module",
|
|
10
10
|
"scripts": {
|