From b3cc3cee1c548b845cc498a94c0acc05865fe2a8 Mon Sep 17 00:00:00 2001 From: Bryan Black Date: Thu, 19 Jul 2018 14:52:49 -0700 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2263456..e5361bc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ -# gpg-agent-forward -Simple GPG agent-forwarding config maker for Yubikey use with SSH +# Forward your Yubikey `gpg-agent` to remote host +### Simple GPG agent-forwarding config maker for Yubikey use with SSH. + +## 📖 Getting Started + +⚠️ Storing SSH keys on disk can be dangerous. Using a hardware crypto key can help mitigate key exfiltration from your local or remote hosts. + +This assumes you [already added a GPG key to your Yubikey](https://github.com/drduh/YubiKey-Guide) and now just want to forward it to a remote host. + +``` +./yubikey_gpg-agent-forward.sh admin host.example.com +```