Update README.md with options.
authorOlof-Joachim Frahm <olof@macrolet.net>
Sun, 11 Jan 2015 00:08:58 +0000 (00:08 +0000)
committerOlof-Joachim Frahm <olof@macrolet.net>
Sun, 11 Jan 2015 00:08:58 +0000 (00:08 +0000)
README.md

index eef6c8a..cad778f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,6 +7,18 @@ Run the script to install a baseline setup for both GnuPG and OpenSSH.
 Existing files are detected and not touched in the process, so running
 it is always safe to do.
 
 Existing files are detected and not touched in the process, so running
 it is always safe to do.
 
+# OPTIONS
+
+- `--no-gui` disables the GUI, which means text mode will be enabled for
+  everything including the passphrase input
+- `--no-gpg` disables the GnuPG key generation and related setup
+  routines
+- `--no-ssh` does the same for the OpenSSH setup
+- `--gpg-home` sets the directory for the GnuPG files
+- `--ssh-home` does the same for OpenSSH files
+
+There is also `-h/--help` and `-v/--version` as expected.
+
 # INSTALLATION
 
 Until I set up a better routine:
 # INSTALLATION
 
 Until I set up a better routine: