action is ready

README.md

@@ -1,2 +1,23 @@
 # sftp-upload-action
-sftp upload using sftp-sync-deploy
+
+this is a github action script for upload files to server via SFTP protocol.
+
+it using [sftp-sync-deploy](https://www.npmjs.com/package/sftp-sync-deploy)
+
+
+## input
+
+```
+  host: 'example.com',            // Required.
+  port: 22,                       // Optional, Default to 22.
+  username: 'user',               // Required.
+  password: 'password',           // Optional.
+  localDir: 'dist',               // Required, Absolute or relative to cwd.
+  remoteDir: '/path/to/dest'      // Required, Absolute path only.
+  dryRun: false                   // Optional. Default to false.
+```
+
+## useful link
+
+<https://www.npmjs.com/package/sftp-sync-deploy>
+<https://github.com/dobbydog/sftp-sync-deploy>

action.yml

@@ -0,0 +1,23 @@
+name: 'SFTP uploader'
+description: 'upload files to server via SFTP'
+inputs:
+  host:
+    required: true
+  port:
+    required: false
+    default: 22
+  username:
+    required: false
+    default: 'root'
+  password:
+    required: true
+  localDir:
+    required: true
+  remoteDir:
+    required: true
+  dryRun:
+    required: false
+    default: false
+runs:
+  using: 'node12'
+  main: 'sftp.js'