Skip to content

Commit

Permalink
README.md update with new doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Unitech authored Jun 8, 2018
1 parent 31e536b commit b3ff38c
Showing 1 changed file with 12 additions and 30 deletions.
42 changes: 12 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">
<br/>
<a href="http://pm2.keymetrics.io" title="PM2 Keymetrics link">
<a href="http://pm2.io/doc/?utm_source=github" title="PM2 Keymetrics link">
<img width=710px src="https://raw.githubusercontent.com/Unitech/pm2/master/pres/pm2-v4.png" alt="pm2 logo">
</a>
<br/>
Expand All @@ -27,13 +27,8 @@
<br/>
</div>

PM2 is a General Purpose Process Manager and a Production Runtime for Node.js apps with a built-in Load Balancer.

Key features:
- Simple and efficient process management (start/stop/restart/delete/show/monit)
- Keep your application ALWAYS ONLINE with auto restarts and init system script generation
- Clusterize Node.js Applications without code change to increase performance and reliability
- Hot Reload Node.js Applications without extra configuration
PM2 is a Production Runtime and Process Manager for Node.js applications with a built-in Load Balancer.
It allows you to keep applications alive forever, to reload them without downtime and facilitate common Devops tasks.

Starting an application in production mode is as easy as:

Expand All @@ -43,13 +38,15 @@ $ pm2 start app.js

PM2 is constantly assailed by [more than 1800 tests](https://travis-ci.org/Unitech/pm2).

Official website: [http://pm2.keymetrics.io/](http://pm2.keymetrics.io/)
Official website: [https://pm2.io/doc/](https://pm2.io/doc/)

Works on Linux (stable) & macOS (stable) & Windows (stable).
All Node.js versions are supported starting Node.js 0.12.

[![NPM](https://nodei.co/npm/pm2.png?downloads=true&downloadRank=true)](https://nodei.co/npm/pm2/)

[Master PM2 with the step by step Guide](https://pm2.io/doc/en/runtime/guide/)

### Installing PM2

```bash
Expand All @@ -68,7 +65,7 @@ $ pm2 start app.js

Your app is now daemonized, monitored and kept alive forever.

[More about Process Management](http://pm2.keymetrics.io/docs/usage/process-management/)
[More about Process Management](https://pm2.io/doc/en/runtime/guide/process-management/?utm_source=github)

### Container Support

Expand All @@ -83,7 +80,7 @@ FROM keymetrics/pm2:latest-alpine
CMD [ "pm2-runtime", "npm", "--", "start" ]
```

[Read More about the dedicated integration](http://pm2.keymetrics.io/docs/usage/docker-pm2-nodejs/)
[Read More about the dedicated integration](https://pm2.io/doc/en/runtime/integration/docker/?utm_source=github)

### Managing a Process

Expand Down Expand Up @@ -117,7 +114,7 @@ To monitor logs, custom metrics, process information:
$ pm2 monit
```

[More about Process Management](http://pm2.keymetrics.io/docs/usage/process-management/)
[More about Process Management](https://pm2.io/doc/en/runtime/guide/process-management/?utm_source=github)

### Cluster Mode: Node.js Load Balancing & Hot Reload

Expand Down Expand Up @@ -227,9 +224,9 @@ $ pm2 flush # Flush all logs
$ pm2 reloadLogs # Reload all logs
```

[More about log management](http://pm2.keymetrics.io/docs/usage/log-management/)
[More about log management](https://pm2.io/doc/en/runtime/guide/log-management/?utm_source=github)

### Startup script generation
### Startup Hooks Generation

PM2 can generates and configure a startup script to keep PM2 and your processes alive at every server restart.

Expand All @@ -253,7 +250,7 @@ To save/freeze a process list on reboot:
$ pm2 save
```

[More about startup scripts](http://pm2.keymetrics.io/docs/usage/startup/)
[More about Startup Hooks](https://pm2.io/doc/en/runtime/guide/startup-hook/?utm_source=github)

### Commands Cheatsheet

Expand Down Expand Up @@ -342,10 +339,6 @@ $ pm2 install <module_name>
Here are some PM2 compatible modules (standalone Node.js applications managed by PM2):

[**pm2-logrotate**](https://github.com/pm2-hive/pm2-logrotate) auto rotate logs of PM2 and applications managed<br/>
[**pm2-webshell**](https://github.com/pm2-hive/pm2-webshell) expose a fully capable terminal in browsers<br/>
[**pm2-server-monit**](https://github.com/pm2-hive/pm2-server-monit) monitor your server health<br/>

[Writing your own module](http://pm2.keymetrics.io/docs/advanced/pm2-module-system/)

## Keymetrics monitoring

Expand All @@ -358,17 +351,6 @@ Feel free to try it:

Thanks in advance and we hope that you like PM2!

## More about PM2

- [Application Declaration via JS files](http://pm2.keymetrics.io/docs/usage/application-declaration/)
- [Watch & Restart](http://pm2.keymetrics.io/docs/usage/watch-and-restart/)
- [PM2 API](http://pm2.keymetrics.io/docs/usage/pm2-api/)
- [Deployment workflow](http://pm2.keymetrics.io/docs/usage/deployment/)
- [PM2 on Heroku/Azure/App Engine](http://pm2.keymetrics.io/docs/usage/use-pm2-with-cloud-providers/)
- [PM2 auto completion](http://pm2.keymetrics.io/docs/usage/auto-completion/)
- [Using PM2 in ElasticBeanStalk](http://pm2.keymetrics.io/docs/tutorials/use-pm2-with-aws-elastic-beanstalk/)
- [PM2 Tutorial Series](https://futurestud.io/tutorials/pm2-utility-overview-installation)

## CHANGELOG

[CHANGELOG](https://github.com/Unitech/PM2/blob/master/CHANGELOG.md)
Expand Down

0 comments on commit b3ff38c

Please sign in to comment.