From 305dff468a17b9a971b88c29ecd757978b36b3e2 Mon Sep 17 00:00:00 2001
From: Samuel N Cui <i@samcui.com>
Date: Tue, 26 Sep 2023 21:46:10 +0800
Subject: [PATCH] fix: readme nginx config

---
 README.md | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 8b0c7a8..3c13a4a 100644
--- a/README.md
+++ b/README.md
@@ -41,7 +41,8 @@ mkdir -p /opt/yatm
 tar -xvzf yatm-linux-amd64-${RELEASE_VERSION}.tar.gz -C /opt/yatm
 
 cp /opt/yatm/config.example.yaml /opt/yatm/config.yaml
-vim /opt/yatm/config.yaml # change config file depends on your demand.
+# change config file depends on your demand.
+vim /opt/yatm/config.yaml
 
 systemctl enable /opt/yatm/yatm-httpd.service
 systemctl start yatm-httpd.service
@@ -53,12 +54,12 @@ YATM is based on GRPC, which needs HTTP2 to be functional. You can reference the
 
 ```nginx config
 server {
-    // needs http2 to proxy grpc
+    # needs http2 to proxy grpc
     listen 443 ssl http2;
     listen [::]:443 ssl http2;
 
     server_name example.com;
-    // if you use basic auth, ssl is critical for protect your password
+    # if you use basic auth, ssl is critical for protect your password
     include includes/ssl.conf;
 
     proxy_connect_timeout 60;
@@ -74,7 +75,7 @@ server {
     http2_max_requests 10000000;
 
     location / {
-        // you can use basic auth to protect your site
+        # you can use basic auth to protect your site
         auth_basic              "restricted";
         auth_basic_user_file    includes/passwd;