From 92bae8bd61b4b168fe8110ac5d6f8f7332f06595 Mon Sep 17 00:00:00 2001
From: redxef <federanko.manuel@gmail.com>
Date: Fri, 6 May 2022 16:01:07 +0200
Subject: [PATCH] Update README.md.

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 43 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 57a1150..1734633 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,21 @@ A resource type for a ssh resource
 ## Source configuration
 
 ```
-
-
+resource_types:
+- name: ssh
+  type: registry-image
+  source:
+    repository: redxef/concourse-ssh-resource
+resources:
+- name: my-server
+  type: ssh
+  source:
+    hostname: ((my-server.hostname))
+    port: ((my-server.port))
+    user: ((my-server.user))
+    identity: ((my-server.identity))
+    hostkey: ((my-server.hostkey))
+    files: []
 ```
 
 - hostname: *Required*. Servers hostname to connect to.
@@ -15,3 +28,31 @@ A resource type for a ssh resource
 - identity: *Required*. The private key used to authenticate.
 - hostkey: *Required*. The hostkey of the server.
 - files: *Optional*. File paths on the remote to get/put
+- directory: *Optional*. *Default* `$HOME`. The remote directory from which to base paths on.
+
+## `check`
+
+Check if any of the listed files on the remote server have been updated.
+
+## `in` receive files
+
+Receive all configured files.
+
+## `out` push files and run command
+
+Push all configured files to the server and run the specified command afterwards.
+
+### Configuration
+
+```
+- put: my-server
+  params:
+    command:
+    - ls
+    - -la
+```
+
+### parameters
+
+- workdir: *Optional*. *Default* `$HOME`. The remote directory to use as `cwd` when running commands.
+- command: *Optional*. *Default* `[true]`. A command to execute on the remote, given as list.