From 8bd4933b73586b028df7d6e9756173a779091964 Mon Sep 17 00:00:00 2001
From: Himanshu Garg <35988194+merrcury@users.noreply.github.com>
Date: Wed, 12 Aug 2020 22:33:55 +0530
Subject: [PATCH] Instructions to use SSH Key (#77)

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

diff --git a/README.md b/README.md
index 0ac0383..747a601 100644
--- a/README.md
+++ b/README.md
@@ -79,6 +79,21 @@ SSH Proxy Setting:
 * proxy_use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#56](https://github.com/appleboy/ssh-action/issues/56))
 * proxy_cipher - the allowed cipher algorithms. If unspecified then a sensible
 
+### Setting up SSH Key
+Make sure to follow the below steps while creating SSH Keys and using them. 
+* Login with username specified in Github Secrets.
+* Generate a RSA Key-Pair. 
+   ```bash 
+   ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
+   ```
+* Add newly generated key into Authorized keys. Read more about authorized keys [here](https://www.ssh.com/ssh/authorized_keys/).
+    ```bash 
+    cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
+    ```
+* Copy Private Key content and paste in Github Secrets. 
+   ```bash 
+   clip < ~/.ssh/id_rsa
+   ```
 ### Example
 
 Executing remote ssh commands using password.