Skip to content

Commit 24adf55

Browse files
committed
pm2@7.0.0
1 parent 36c3b51 commit 24adf55

1 file changed

Lines changed: 10 additions & 14 deletions

File tree

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ Starting an application in production mode is as easy as:
3434
$ pm2 start app.js
3535
```
3636

37-
PM2 is constantly assailed by [more than 1800 tests](https://github.com/Unitech/pm2/actions/workflows/node.js.yml).
37+
PM2 is constantly assailed by [a comprehensive test suite](https://github.com/Unitech/pm2/actions/workflows/node.js.yml).
3838

3939
Official website: [https://pm2.keymetrics.io/](https://pm2.keymetrics.io/)
4040

41-
Works on Linux (stable) & macOS (stable) & Windows (stable). All Node.js versions are supported starting Node.js 18.X and Bun since v1
41+
Works on Linux, macOS, and Windows. Supports Node.js 18+ and Bun 1+.
4242

4343

4444
## Installing PM2
@@ -54,10 +54,6 @@ $ npm install pm2 -g
5454
```bash
5555
$ bun install pm2 -g
5656
```
57-
**If Node.js is not installed**, PM2 binaries use `#!/usr/bin/env node` as shebang, so you need to symlink `node` to `bun`:
58-
```bash
59-
$ sudo ln -s $(which bun) /usr/local/bin/node
60-
```
6157

6258
___
6359

@@ -109,9 +105,9 @@ $ pm2 monit
109105

110106
### Cluster Mode: Node.js Load Balancing & Zero Downtime Reload
111107

112-
The Cluster mode is a special mode when starting a Node.js application, it starts multiple processes and load-balance HTTP/TCP/UDP queries between them. This increase overall performance (by a factor of x10 on 16 cores machines) and reliability (faster socket re-balancing in case of unhandled errors).
108+
Cluster mode starts multiple Node.js processes and load-balances HTTP/TCP/UDP queries between them. This significantly increases throughput on multi-core machines and improves reliability (faster socket re-balancing in case of unhandled errors).
113109

114-
![Framework supported](https://raw.githubusercontent.com/Unitech/PM2/master/pres/cluster.png)
110+
![Framework supported](https://raw.githubusercontent.com/Unitech/pm2/master/pres/cluster.png)
115111

116112
Starting a Node.js application in cluster mode that will leverage all CPUs available:
117113

@@ -129,14 +125,14 @@ Hot Reload allows to update an application without any downtime:
129125
$ pm2 reload all
130126
```
131127

132-
[More informations about how PM2 make clustering easy](https://pm2.keymetrics.io/docs/usage/cluster-mode/)
128+
[More information about how PM2 makes clustering easy](https://pm2.keymetrics.io/docs/usage/cluster-mode/)
133129

134130
### Container Support
135131

136132
With the drop-in replacement command for `node`, called `pm2-runtime`, run your Node.js application in a hardened production environment.
137133
Using it is seamless:
138134

139-
```
135+
```dockerfile
140136
RUN npm install pm2 -g
141137
CMD [ "pm2-runtime", "npm", "--", "start" ]
142138
```
@@ -154,7 +150,7 @@ $ pm2 set pm2:sysmonit true
154150
$ pm2 update
155151
```
156152

157-
![Framework supported](https://raw.githubusercontent.com/Unitech/PM2/master/pres/vitals.png)
153+
![Framework supported](https://raw.githubusercontent.com/Unitech/pm2/master/pres/vitals.png)
158154

159155
### Terminal Based Monitoring
160156

@@ -174,7 +170,7 @@ To consult logs just type the command:
174170
$ pm2 logs
175171
```
176172

177-
Standard, Raw, JSON and formated output are available.
173+
Standard, Raw, JSON and formatted output are available.
178174

179175
Examples:
180176

@@ -199,7 +195,7 @@ $ pm2 install pm2-logrotate
199195

200196
PM2 can generate and configure a Startup Script to keep PM2 and your processes alive at every server restart.
201197

202-
Init Systems Supported: **systemd**, **upstart**, **launchd**, **rc.d**
198+
Init Systems Supported: **systemd**, **upstart**, **systemv**, **openrc**, **launchd**, **rcd**, **rcd-openbsd**, **smf**
203199

204200
```bash
205201
# Generate Startup Script
@@ -239,7 +235,7 @@ Thanks in advance and we hope that you like PM2!
239235

240236
## CHANGELOG
241237

242-
[CHANGELOG](https://github.com/Unitech/PM2/blob/master/CHANGELOG.md)
238+
[CHANGELOG](https://github.com/Unitech/pm2/blob/master/CHANGELOG.md)
243239

244240
## Contributors
245241

0 commit comments

Comments
 (0)