From ac58d3bc31eeccc35fc0234db539ce9c4e8feb55 Mon Sep 17 00:00:00 2001
From: Cristian Romanescu <cristian@romanescu.ro>
Date: Mon, 20 Mar 2023 23:51:17 +0200
Subject: [PATCH] Add documentation

---
 README.md | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 07f0bc8..0572000 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,17 @@
 # drupal-cleanup-action
-Cleanup older deployments
+
+SSH into a remote server and cleanup older deployments (directories) with defined pattern. Preserve only the newest number of configured directories.
+
+Usage:
+
+```
+      - name: 'Cleanup old releases'
+        uses: eaudeweb/drupal-cleanup-action@1.x
+        with:
+          ssh_user:             ${{ secrets.TEST_SSH_USER }}
+          ssh_host:             ${{ secrets.TEST_SSH_HOST }}
+          ssh_key:              ${{ secrets.TEST_SSH_KEY }}
+          cleanup_dir:          /var/www/artifacts/example.org
+          pattern:              release-*
+          retain:               5
+```