From 1731bfee1004d3b8b0ba2fc9e44411689345e61b Mon Sep 17 00:00:00 2001
From: Karsten Dambekalns <karsten@flownative.com>
Date: Tue, 20 Jul 2021 15:39:04 +0200
Subject: [PATCH] Document path-style endpoint option

See #42 and #37 for the rationale.
---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index d3d547b..b412657 100644
--- a/README.md
+++ b/README.md
@@ -328,3 +328,18 @@ Flownative:
             secret: 'abcdefgHIJKLMNOP1234567890QRSTUVWXYZabcd'
           endpoint: 'https://storage.googleapis.com/mybucket.flownative.net'
 ```
+
+## Path-style endpoints
+
+When using a custom endpoint for a non-AWS, S3-compatible storage, the use of this option may be needed.
+
+```yaml
+Flownative:
+  Aws:
+    S3:
+      profiles:
+        default:
+          endpoint: 'https://abc.objectstorage.provider.tld/my-bucket-name'
+          # Prevents the AWS client to prepend the bucket name to the hostname
+          use_path_style_endpoint: true
+```