From 4f3c356bab09bb13b4a56a24bd2ce21eff1f17cf Mon Sep 17 00:00:00 2001 From: ybouane Date: Sat, 12 Oct 2024 11:54:15 -0400 Subject: [PATCH] Updated README.md --- README.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2dcfb4c..0033009 100644 --- a/README.md +++ b/README.md @@ -63,17 +63,31 @@ export default { # Installation Clone the repo: -`git clone https://github.com/ybouane/aPulse.git` +```shell +git clone https://github.com/ybouane/aPulse.git +``` Either run the watcher.js script directly (you need to keep it running in the background) -`cd aPulse` -`node watcher.js` +```shell +cd aPulse +``` +```shell +node watcher.js +``` Or use a tool like PM2 (prefered method): -`npm install pm2 -g` +```shell +npm install pm2 -g +``` Start watcher.json -`pm2 start pm2.json` +```shell +pm2 start pm2.json +``` Configure pm2 to automatically start during startup -`pm2 startup` +```shell +pm2 startup +``` Save current pm2 processes list -`pm2 save` \ No newline at end of file +```shell +pm2 save +```