summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Unterwurzacher2015-09-08 23:09:28 +0200
committerJakob Unterwurzacher2015-09-08 23:09:28 +0200
commit80935a0e1b3848608bcc8e1e1497435801ac9940 (patch)
tree020eff5e8949dafaf6fcc3ccfacb1794b8eeac3a /README.md
parentbfdbbbf8b476c810ac9d5c47a7fa6f7cc8904a55 (diff)
Explain both frontends in readme
Also, re-enable openssl and disable debug messages so testing gocryptfs is less painful
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.md b/README.md
index d8f3999..94c3c55 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,20 @@ GoCryptFS
=========
A minimal encrypted overlay filesystem written in Go.
-Built on top of the
-native Go FUSE library [bazil.org/fuse](https://github.com/bazil/fuse)
-and the [ClueFS](https://github.com/airnandez/cluefs) loopback file system.
-
Inspired by [EncFS](https://github.com/vgough/encfs).
+GoCryptFS at the moment has two FUSE frontends:
+
+* The [go-fuse](https://github.com/hanwen/go-fuse) FUSE library using its
+ LoopbackFileSystem API
+* The FUSE library [bazil.org/fuse](https://github.com/bazil/fuse) plus the
+ [ClueFS](https://github.com/airnandez/cluefs) loopback filesystem
+
+A frontend is selected on compile-time by setting `USE_CLUEFS` to true or false
+(default false).
+Once I decide that one works better for GoCryptFS, the other one
+will go away.
+
Design
------
* Authenticated encryption of file contents using AES-GCM-128