Add a bit of documentation, environment variables.

[crypto-install.git] / README.md

diff --git a/README.md b/README.md
index 50a36c8..278752f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,11 +14,17 @@ it is always safe to do.
 - `--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
+- `--gpg-home` sets the directory for the GnuPG files (defaults to the
+  value of `GNUPGHOME` or `~/.gnupg`)
+- `--ssh-home` does the same for OpenSSH files (defaults to `~/.ssh`)
 
 There is also `-h/--help` and `-v/--version` as expected.
 
+# ENVIRONMENT
+
+- `FULLNAME`, `EMAIL`, `USER` are used to pre-fill the corresponding
+  fields
+
 # INSTALLATION
 
 Until I set up a better routine: