From: Olof-Joachim Frahm <olof@macrolet.net>
Date: Sun, 11 Jan 2015 00:08:58 +0000 (+0000)
Subject: Update README.md with options.
X-Git-Tag: 0.1.0~2^2~28
X-Git-Url: http://repo.macrolet.net/gitweb/?p=crypto-install.git;a=commitdiff_plain;h=f7ada8e8997481733847a14aa1df9a08ef20666d

Update README.md with options.
---

diff --git a/README.md b/README.md
index eef6c8a..cad778f 100644
--- 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.
 
+# 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: