From cf3919fea29cb4064f0c22fd5ba270318856d0f2 Mon Sep 17 00:00:00 2001
From: davesavic <davesavic27@gmail.com>
Date: Mon, 1 Jan 2024 21:04:25 +1000
Subject: [PATCH] Updated readme

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

diff --git a/README.md b/README.md
index 00681ee..d429e66 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,48 @@
 # Ploy
 ### A simplified deployment and task automation tool.
 
+**Usage**: `ploy [command] [options]`
+
+**Commands**:
+- `ploy init` - Initialize a new template ploy script.
+- `ploy run [options] [pipeline]...` - Run pipelines on their respective servers (provide -l to run them locally).
+
+**Configuration structure**:
+```json
+{
+    "params": {
+        // Parameters to be populated within tasks
+        // Keys are the parameter names, values are the parameter values
+        "message": "hello, world!"
+    },
+    "servers": {
+        // Servers to be used in pipelines
+        // Keys are the server names, values are the server configurations
+        "staging": {
+            "host": "111.111.111.111",
+            "port": 22,
+            "user": "ploy",
+            "private-key": "/home/user/.ssh/id_rsa"
+        }
+    },
+    "tasks": {
+        // Tasks to be used in pipelines
+        // Keys are the task names, values are the task commands
+        "print-message": [
+            "echo '{{message}}'"
+        ]
+    },
+    "pipelines": {
+        // Pipelines to be run
+        // Keys are the pipeline names, values are the pipeline configurations
+        "say-hello": {
+            "servers": [
+                "staging"
+            ],
+            "tasks": [
+                "print-message"
+            ]
+        }
+    }
+}
+```
\ No newline at end of file