aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Unterwurzacher2017-02-12 19:12:02 +0100
committerJakob Unterwurzacher2017-02-12 19:20:21 +0100
commit54caaf4b980e0432baef54c5129aa53c43be70e8 (patch)
tree6181128532b23db5952b59379adf24be35b063bc /README.md
parent8adfbf2dc34560df7436c89b59a9749d2dd3b78e (diff)
Add CLI ABI documentation
Closes https://github.com/rfjakob/gocryptfs/issues/77
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index f130c52..905c3c0 100644
--- a/README.md
+++ b/README.md
@@ -79,6 +79,13 @@ The [MANPAGE.md](Documentation/MANPAGE.md) containes a description of available
If you already have gocryptfs installed, run `./MANPAGE-render.bash` to bring up the rendered manpage in
your man pager (requires pandoc).
+Stable CLI ABI
+--------------
+
+If you want to call gocryptfs from your app or script, see
+[CLI_ABI.md](Documentation/CLI_ABI.md) for the official stable
+ABI. This ABI is regression-tested by the test suite.
+
Storage Overhead
----------------