From 5f434a7249e81556523509787c22d5897f6d91d1 Mon Sep 17 00:00:00 2001
From: Paul Hummer <paul@eventuallyanyway.com>
Date: Fri, 18 May 2018 19:37:59 -0600
Subject: Initial commit
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

♬ : Midtown / Like a Movie
---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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)
-- 
cgit v1.2.3