From 279c5c55ebaadd91c6aa868bc0441874f0a1e5c7 Mon Sep 17 00:00:00 2001
From: Jimmy Reichley <jimmyqpublik@gmail.com>
Date: Fri, 29 Sep 2023 01:10:27 -0400
Subject: [PATCH] Some docs about sshConfigHost

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index d470a23..c4f6255 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,10 @@ Below is a minimal example:
             _module.args.nixinate = {
               host = "itchy.scratchy.com";
               sshUser = "matthew";
+
+              # Or optionally pass a 'short' hostname that is defined in ssh config
+              sshConfigHost = "itchy-scratchy";
+
               buildOn = "remote"; # valid args are "local" or "remote"
               substituteOnTarget = true; # if buildOn is "local" then it will substitute on the target, "-s"
               hermetic = false;
@@ -91,6 +95,11 @@ Connection to itchy.scratchy.com closed.
 
    A string representing the username a machine to connect to via ssh.
 
+- `sshConfigHost` *`string`*
+
+   A string representing an entry in ssh config. If provided, it takes precedence
+   over `host` and `sshUser`.
+
 - `buildOn` *`"remote"`* or *`"local"`*
 
   - `"remote"`