From d9b4f96598ec7227a5c6b756f14b982771e40d20 Mon Sep 17 00:00:00 2001
From: Jakob Unterwurzacher
Date: Wed, 7 Oct 2015 23:30:45 +0200
Subject: Update README

---
 README.md | 31 ++++++++++++++++++++++++++-----
 1 file changed, 26 insertions(+), 5 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index c9162b6..96acd59 100644
--- a/README.md
+++ b/README.md
@@ -9,26 +9,47 @@ LoopbackFileSystem API.
 This project was inspired by [EncFS](https://github.com/vgough/encfs)
 and strives to fix its security issues (see EncFS tickets 9, 13, 14, 16).
 For details on the security of GoCryptFS see the
-[SECURITY.md](https://github.com/rfjakob/gocryptfs/blob/master/SECURITY.md)
-document.
+[SECURITY.md](SECURITY.md) document.
 
 Current Status
 --------------
 * First public release
 * Feature-complete
-* Passes the xfstests "generic" tests
+* Passes the fuse-xfstests "generic" tests with one exception, results: [XFSTESTS.md](XFSTESTS.md)
+ * A lot of work has gone into this. The testing has found bugs in gocryptfs
+   as well as in go-fuse.
+ * The one exceptions generic/035. This is a limitation in go-fuse,
+   check out https://github.com/hanwen/go-fuse/issues/55 for details.
+* However, gocryptfs needs more real-world testing - please report any issues via github.
 
 Install
 -------
 
-	go get github.com/rfjakob/gocryptfs
+	$ go get github.com/rfjakob/gocryptfs/...
+
+(The dots are important!)
+
+Use
+---
+
+	$ mkdir cipher plain
+	$ alias gocryptfs="$GOPATH/src/github.com/rfjakob/gocryptfs/gocryptfs"
+	$ gocryptfs --init cipher
+	  [...]
+	$ gocryptfs cipher plain
+	  [...]
+	$ echo test > plain/test.txt
+	$ ls -l cipher
+	  total 8
+	  -rw-rw-r--. 1 user  user   33  7. Okt 23:23 0ao8Hyyf1A-A88sfNvkUxA==
+	  -rw-rw-r--. 1 user  user  233  7. Okt 23:23 gocryptfs.conf
 
 Performance
 -----------
 
  * 28 bytes of storage overhead per block (16 bytes auth tag, 12 byte nonce)
  * uses openssl through [spacemonkeygo/openssl](https://github.com/spacemonkeygo/openssl)
-   for a 3x speedup compared to `crypto/cipher` (see [go-vs-openssl.md](https://github.com/rfjakob/gocryptfs/blob/master/openssl_benchmark/go-vs-openssl.md)) for details
+   for a 3x speedup compared to `crypto/cipher` (see [go-vs-openssl.md](openssl_benchmark/go-vs-openssl.md) for details
 
 Run `./benchmark.bash` to run the test suite and the streaming read/write
 benchmark. The benchmark is run twice, first with native Go crypto and
-- 
cgit v1.2.3