From 1c9a652ab35b2459093f6290ffbb16b83dd56a85 Mon Sep 17 00:00:00 2001 From: mhogomchungu Date: Tue, 1 Dec 2020 11:24:11 +0300 Subject: [PATCH] update documentation --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 47034a8..8d56c09 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ +To make SiriKali aware of cryptomator-cli, download cryptomator-cli.jar file from the release page and put it +in "$HOME/.bin" folder if you want to place it in your home directory or in traditional paths for executables +like "/usr/bin" or "/usr/local/bin". + This project is a fork of https://github.com/cryptomator/cli and currently, it adds the following functionality:- 1. "--version" argument to print version information. 2. "--mountFlags" argument to add FUSE options. 3. "--foreground" argument to cause the program to run in the foreground. - Not adding the feature causes the program to run daemonized(currently not supported) + Not adding the feature causes the program to run daemonized(currently not supported). 4. A preffered way to lock a vault is by using "fusermount -u $MOUNT_POINT_PATH" and not sending SIGTERM signal. The benefit of this approach is fusermount's ability to notice if the mount point is in use or not and to refuse to unmount if it is. The SIGTERM approach just nukes the process even when mount points are in use and this may