diff options
author | Paul Hummer <paul@eventuallyanyway.com> | 2018-05-18 19:37:59 -0600 |
---|---|---|
committer | Paul Hummer <paul@eventuallyanyway.com> | 2018-05-18 19:37:59 -0600 |
commit | 5f434a7249e81556523509787c22d5897f6d91d1 (patch) | |
tree | a301808d81df39627c53efa236966c3a0d92f5d3 /README.md |
Initial commit
♬ : Midtown / Like a Movie
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c5ca11d --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +pidlock +== + +A library for working with pidfiles, with a lock-like API. + +Usage +-- + +``` +extern crate pidlock; + +fn main() { + let mut lock = pidlock::Pidlock("/path/to/pidfile.pid"); + lock.acquire().unwrap(); + + ... + + lock.release().unwrap(); +} +``` + +License +-- + +pidlock is licensed under the MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) |