From 544f1f2a603843303d094ad7f1f968e7c8a9bcd4 Mon Sep 17 00:00:00 2001 From: Josh Sherman Date: Tue, 25 Nov 2014 23:50:53 -0500 Subject: [PATCH] Updated README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 04e4aa2..81d813e 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,14 @@ I just wanted a way to see if a process was already running and if not, run the damn code. I also wanted to do this in a very simple fashion, by way of a callback. And thus, I give you `simple-pid`. +## Installation + +Usual shit: + +```shell +npm install simple-pid +``` + ## Usage ```javascript @@ -33,3 +41,10 @@ the code in the callback will be executed. You know it! Because this module writes to the `/var/run` directory it requires write access to that directory. This is best accomplished by running your script as root or by way of `sudo`. + +## Wait, no cleanup? + +Nah, I felt that cleaning up the PID file (by removing it post-execution) was +just an unnecessary layer that could be omitted. Could you run into some sort of +PID collision? Never say never, but thus far we haven’t seen any fallout from +this and I really did want to keep the code as stupid simple as possible.