From d92230e22b716e9b0c8bc1086477415f8b90e77f Mon Sep 17 00:00:00 2001
From: Ayman Bagabas <ayman.bagabas@gmail.com>
Date: Tue, 10 Sep 2024 10:39:16 -0400
Subject: [PATCH] docs: update required fields (#54)

* docs: update required fields

Fixes: https://github.com/caddy-dns/route53/issues/48

* Update README.md
---
 README.md | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index ae825f2..2b104d9 100644
--- a/README.md
+++ b/README.md
@@ -30,12 +30,12 @@ To use this module for the ACME DNS challenge, [configure the ACME issuer in you
       "provider": {
         "name": "route53",
         "max_retries": 10, // optional
-        "profile": "real-profile", // optional
-        "region": "us-east-1", // optional
-        "access_key_id": "AKI...", // optional
-        "secret_access_key": "wJa...", // optional
-        "session_token": "TOKEN...", // optional
-        "max_wait_dur": 60, // propagation wait duration (optional)
+        "profile": "real-profile", // defaults to $AWS_PROFILE
+        "region": "us-east-1", // required if $AWS_REGION is not defined
+        "access_key_id": "AKI...", // required if $AWS_ACCESS_KEY_ID is not defined
+        "secret_access_key": "wJa...", // required if $AWS_SECRET_ACCESS_KEY is not defined
+        "session_token": "TOKEN...", // defaults to $AWS_SESSION_TOKEN (optional)
+        "max_wait_dur": 60, // propagation wait duration in seconds (optional)
         "wait_for_propagation": false, // wait for records to propagate (optional)
         "hosted_zone_id": "ZABCD1EFGHIL" // AWS hosted zone ID to update (optional)
       }
@@ -46,16 +46,16 @@ To use this module for the ACME DNS challenge, [configure the ACME issuer in you
 
 or with the Caddyfile:
 
-```
+```caddy
 tls {
   dns route53 {
     max_retries 10 // optional
-    profile "real-profile" // optional
-    access_key_id "AKI..." // optional
-    secret_access_key "wJa..." // optional
-    session_token "TOKEN..." // optional
-    region "us-east-1" // optional
-    max_wait_dur 60, // propagation wait duration (optional)
+    profile "real-profile" // defaults to $AWS_PROFILE
+    access_key_id "AKI..." // required if $AWS_ACCESS_KEY_ID is not defined
+    secret_access_key "wJa..." // required if $AWS_SECRET_ACCESS_KEY is not defined
+    session_token "TOKEN..." // defaults to $AWS_SESSION_TOKEN (optional)
+    region "us-east-1" // required if $AWS_REGION is not defined
+    max_wait_dur 60, // propagation wait duration in seconds (optional)
     wait_for_propagation false // wait for records to propagate (optional)
     hosted_zone_id ZABCD1EFGHIL // AWS hosted zone ID to update (optional)
   }