From 20e5b303d1e7a68e1f80eb696758ad1cc887ce73 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20L=C3=B6per?= <martin.loeper@nesto-software.de>
Date: Thu, 28 Mar 2024 22:06:23 +0100
Subject: [PATCH] docs: add output format to docs

---
 README.md | 13 ++++++++++++-
 result    |  1 -
 2 files changed, 12 insertions(+), 2 deletions(-)
 delete mode 120000 result

diff --git a/README.md b/README.md
index 9672236..57175ce 100644
--- a/README.md
+++ b/README.md
@@ -40,4 +40,15 @@ SELECTED_S3_KEY=$(cat $TMP_FILE | jq -r '.prefix')
 
 This tool uses *inquirer-s3* under the hood which depends on an old version of *inquirer*.
 In new versions of inquirer, there is a [fix](https://github.com/pnp/cli-microsoft365/issues/5489) to this problem and inquirer uses stderr insted of stdout.
-We work around this limitation by using our custom file description with number 3.
\ No newline at end of file
+We work around this limitation by using our custom file description with number 3.
+
+## Output
+
+```json
+{ 
+    "bucket": "acme-bucket",
+    "prefix":"09036d7c13ed8e39d23d5552b0f46fb5125764f2df8c85fd313873931631ceff.zip",
+    "objectUrl":"https://s3.amazonaws.com/acme-bucket/09036d7c13ed8e39d23d5552b0f46fb5125764f2df8c85fd313873931631ceff.zip",
+    "s3Uri":"s3://acme-bucket/09036d7c13ed8e39d23d5552b0f46fb5125764f2df8c85fd313873931631ceff.zip"
+}
+```
\ No newline at end of file
diff --git a/result b/result
deleted file mode 120000
index ce586b2..0000000
--- a/result
+++ /dev/null
@@ -1 +0,0 @@
-/nix/store/v8xgkdv6zm8i2nha2i0bdlq2iyh3kl0i-s3-browser-cli-1.0.1
\ No newline at end of file