joshtronic/simple-pid
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
Josh Sherman 2014-11-25 23:50:53 -05:00
parent 2bd257245a
commit 544f1f2a60
1 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -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 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`. callback. And thus, I give you `simple-pid`.
## Installation
Usual shit:
```shell
npm install simple-pid
```
## Usage ## Usage
```javascript ```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 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 write access to that directory. This is best accomplished by running your script
as root or by way of `sudo`. 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.