From 4507e5e4f0b168fcd8dec7da8e45d87ba4cc2211 Mon Sep 17 00:00:00 2001
From: Bo-Yi Wu <appleboy.tw@gmail.com>
Date: Fri, 3 Mar 2017 16:11:21 +0800
Subject: [PATCH] docs: improve docs (#50)

---
 DOCS.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/DOCS.md b/DOCS.md
index 7d5956f..d6ee0ff 100644
--- a/DOCS.md
+++ b/DOCS.md
@@ -33,6 +33,39 @@ pipeline:
 +    - foo.com
 +    - bar.com
     username: root
+    password: 1234
+    port: 22
+    script:
+      - echo hello
+      - echo world
+```
+
+Example configuration for login with private key:
+
+```diff
+pipeline:
+  ssh:
+    image: appleboy/drone-ssh
+    host: foo.com
+    username: root
+-   password: 1234
++   key: ${DEPLOY_KEY}
+    port: 22
+    script:
+      - echo hello
+      - echo world
+```
+
+Example configuration for login with file path of private key:
+
+```diff
+pipeline:
+  ssh:
+    image: appleboy/drone-ssh
+    host: foo.com
+    username: root
+-   password: 1234
++   key_path: ./deploy/key.pem
     port: 22
     script:
       - echo hello