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)