add README

1 files changed, 26 insertions, 0 deletions

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