From 6f8df1ecec5461565092a2f95006d934051c48ad Mon Sep 17 00:00:00 2001
From: Linus Nordberg <linus@sunet.se>
Date: Mon, 24 Jun 2019 10:02:41 +0200
Subject: add README

---
 p11p-daemon/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 p11p-daemon/README.md

diff --git a/p11p-daemon/README.md b/p11p-daemon/README.md
new file mode 100644
index 0000000..d228faf
--- /dev/null
+++ b/p11p-daemon/README.md
@@ -0,0 +1,26 @@
+# p11p is a PKCS #11 proxy
+
+## Compile
+
+If you don't have rebar3 installed, install it. Example:
+
+    FIXME
+
+If you don't have rebar3 in PATH, add it. Example:
+
+    $ export PATH=$PATH:~/.cache/rebar3/bin
+
+Compile:
+
+    $ make
+
+## Run
+
+To start an Erlang shell running the p11p application:
+
+    $ make shell
+
+A socket file per configured token can now be found in /run/user/$UID/p11p/.
+
+    $ echo foo | socat - UNIX-CONNECT:/run/user/1000/p11p/vtoken0
+	ok, thanks: foo
-- 
cgit v1.1