From eeee5dedbae581e3836bfd410ea5fabb8b2b3ead Mon Sep 17 00:00:00 2001
From: Anthony Donlon <idonlon@hotmail.com>
Date: Wed, 19 Nov 2025 21:18:53 +0800
Subject: [PATCH] doc: add more comments in example in readme

---
 README.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fffe98b..7e8fb2a 100644
--- a/README.md
+++ b/README.md
@@ -18,20 +18,26 @@ Then you can generate an error page based on parameters you like. (See [example.
 import webbrowser
 from cloudflare_error_page import render as render_cf_error_page
 
+# This function renders an error page based on the input parameters
 error_page = render_cf_error_page({
+    # Browser status is ok
     'browser_status': {
         "status": 'ok',
     },
+    # Cloudflare status is error
     'cloudflare_status': {
         "status": 'error',
         "status_text": 'Not Working',
     },
+    # Host status is also ok
     'host_status': {
         "status": 'ok',
         "location": 'example.com',
     },
-    'error_source': 'cloudflare',  # 'browser', 'cloudflare', or 'host'
+    # can be 'browser', 'cloudflare', or 'host'
+    'error_source': 'cloudflare',
 
+    # Texts shown in the bottom of the page
     'what_happened': '<p>There is an internal server error on Cloudflare\'s network.</p>',
     'what_can_i_do': '<p>Please try again in a few minutes.</p>',
 })