docs: add output format to docs

nesto-software · Mar 28, 2024 · 20e5b30 · 20e5b30
1 parent 60509a0
commit 20e5b30
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git 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.
+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"
+}
+```
diff --git a/result b/result