From df1c510b3d607bf357ab1f5ae66e45c988c7252e Mon Sep 17 00:00:00 2001
From: Falk Werner <falk.werner@gmx.net>
Date: Sun, 27 Jan 2019 12:32:02 +0100
Subject: [PATCH] provide basic readme

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 52d6960..ca11da7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
 # fuse-wsfs
-websocket filesystem based on libfuse
+
+fuse-wsfs combines libwebsockets and libfuse. It allows ot attach a remote filesystem via websockets.
+
+**Status**: Proof of concept
+
+# Build and run
+
+    cd fuse-wsfs
+    mkdir ./build
+    cd ./build
+    cmake ..
+    make
+    mkdir test
+    ./wsfs -s -f --document_root=`realpath ../src/app/www` --port=4711 test
+
+
+# Dependencies
+
+- [libfuse3](https://github.com/libfuse/libfuse/)
+- [libwebsockets](https://libwebsockets.org/)
+- [Jansson](https://jansson.readthedocs.io)
+
+