From 22cb803624870d72b8061dc82dc74ab9da736ee6 Mon Sep 17 00:00:00 2001
From: Russ Long <rlong@nabancard.com>
Date: Thu, 7 Feb 2019 13:49:53 -0500
Subject: [PATCH] Add Readme

---
 README.md | 14 ++++++++++++++
 ssh.sh    |  2 +-
 2 files changed, 15 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cab836b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Purpose
+This script allows you to ssh to a server using an SSH Key and passphrase pulled from your lastpass account.
+
+# Requirements
+This script requires the `lastpass-cli` and `expect` packages.
+
+The SSH Key must be stored in your lastpass account, as a Secure Note of the type SSH Key, with the Private Key and Passphrase fields filled out, at a minimum.
+
+# Usage
+1. Download the script to a location of your choosing, ensuring it is executable
+2. run it like this: ```./ssh.sh KEYNAME server-you-wish-to-ssh-to```
+
+# How it works
+This script uses the official `lastpass-cli` package to pull the private key to a file and the private key passphrase to a variable.  The script then uses that information to ssh to the requested server, and removes the private key when the connection is closed.
diff --git a/ssh.sh b/ssh.sh
index 85ac9b4..6310497 100755
--- a/ssh.sh
+++ b/ssh.sh
@@ -18,7 +18,7 @@ keyfile=$HOME/.ssh/${keyname}_$(date "+%F-%T")
   fi
 #}
 
-#Fetch private key and place in /home/$user/.ssh/$hostname.datetime
+#Fetch private key and place in /home/$user/.ssh/$keyname_datetime
 lpass show $keyname --field="Private Key" > $keyfile
 chmod 0600 $keyfile