From cd0e125d17430685c4934f118546ab453fe50634 Mon Sep 17 00:00:00 2001 From: Hanjie Wang Date: Tue, 21 Mar 2017 11:33:01 -0500 Subject: [PATCH] make readme more readable --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 956b33c..3f3eed2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ pm2-gui [![NPM version](https://badge.fury.io/js/pm2-gui.svg)](http://badge.fury An elegant web & terminal interface for Unitech/PM2. > Compatible with PM2 v0.12.7+ + > If you wanna update to pm2-gui@latest, make sure you've read the [change logs](CHANGELOG.md). + > You can track lifecycle by [pm2-ant](https://github.com/Tjatse/pm2-ant) ![image](screenshots/pm2-gui.gif) @@ -21,8 +23,9 @@ An elegant web & terminal interface for Unitech/PM2. ![image](screenshots/design.jpg) - + # Features + - Curses-like dashboard. - Remoting monitor / web control. - All the heartbeats (no matter **monitor** or **tail (logs)**) are automatic destroyed. @@ -37,13 +40,15 @@ An elegant web & terminal interface for Unitech/PM2. - Supports [ANSI color codes](#ss_logs) by [ansi-html](https://github.com/Tjatse/ansi-html). - High performance. In my case, there are near one hundred processes, but `pm2-gui` works without any suck. - + # Cautions + - Web Interface is wrote by CSS3 && HTML5, so view it with the latest version of the browser (WebGL, Animation, WebSocket supports), e.g. Chrome, Safari and Firefox. - I've never test it on Internet Explorer / Windows. - + # Installation + ```bash $ npm install pm2-gui -g $ pm2-gui [options] @@ -58,8 +63,9 @@ $ npm install --production $ ./pm2-gui [options] ``` - + # Usage + Run the following command to get usage helps: ```bash $ pm2-gui @@ -78,12 +84,14 @@ pm2GUI.startAgent([ini_config_file]); pm2GUI.dashboard([ini_config_file]); ``` - + # Configuration + Edit the `pm2-gui/pm2-gui.ini` file or copy the [config example](./pm2-gui.ini) to `/etc/pm2-gui.ini` (starting with `pm2-gui start /etc/pm2-gui.ini`): - + # UI/UX + - Amazing and smooth animations. - High performance. @@ -115,10 +123,11 @@ Tail Logs ![image](screenshots/logs.jpg) - + + # Serving apps locally with nginx and custom domain - [simple](examples/nginx/pm.example.com.conf) -- [advantage](examples/nginx/pm2.example.com.conf) +- [advanced](examples/nginx/pm2.example.com.conf) ## Test ```bash