readme

README.md

@@ -9,3 +9,23 @@ Build a Docker image from the given Dockerfile and run the container with `confi
 A prebuilt docker image could be found at `nanahira/cdn-node-checker` at DockerHub or `git-registry.mycard.moe/nanahira/cdn-node-checker` at MyCard Git.
 
 **Important: Make sure to use public DNS in the container.** You may want to use the `dns: 114.114.114.114` option in `docker-compose.yml` file.
+
+## Config example
+
+```yaml
+aliyun:
+  accessKeyId: "" # Your aliyun access key here.
+  accessKeySecret: ""
+  endpoint: "https://alidns.aliyuncs.com"
+  apiVersion: "2015-01-09"
+domain: yuzurisa.com
+cdnRecords: # You may add multiple.
+  - match: '^cdn-[-a-zA-Z]+$' # The matching domain records for CDN.
+    port: 443 # Change this if you are using non-standard ports.
+testDomains:
+  - ygobbs.com # Testing sources.
+  - nanahira.momobako.com
+timeout: 10000
+cronString: "0 * * * * *"
+
+```

config.example.yaml

 aliyun:
-  accessKeyId: ""
+  accessKeyId: "" # Your aliyun access key here.
   accessKeySecret: ""
   endpoint: "https://alidns.aliyuncs.com"
   apiVersion: "2015-01-09"
 domain: yuzurisa.com
-cdnRecords:
-  - match: '^cdn-[-a-zA-Z]+$'
-    port: 443
+cdnRecords: # You may add multiple.
+  - match: '^cdn-[-a-zA-Z]+$' # The matching domain records for CDN.
+    port: 443 # Change this if you are using non-standard ports.
 testDomains:
-  - ygobbs.com
+  - ygobbs.com # Testing sources.
   - nanahira.momobako.com
 timeout: 10000
 cronString: "0 * * * * *"