Merge pull request #5 from Lance52259/br_markdown_content_supplement

docs(document): update the README content

Author: Lance52259

Diff for: README.md

@@ -1,8 +1,23 @@
 # The Terraform module of HUAWEI Cloud VPN service
 
-What capabilities does the current Module provide:
+What capabilities does the current module provide:
 
-+ One-click deployment of VPN resources.
++ Flexible VPN resource combination (through multiple VPN sub-modules)
++ Abundant example references, one-click deployment of VPN resources.
+
+## Notes
+
+If you want to manage VPN resources using Terraform module (via this repository), you need to make the following
+declaration in the `source` of the script.
+
+```hcl
+# Use the latest version.
+module "vpn_gateway" {
+  source = "github.com/terraform-huaweicloud-modules/terraform-huaweicloud-vpn/modules/vpn-gateway"
+
+  ...
+}
+```
 
 ## Contributing
 
@@ -18,14 +33,18 @@ Full contributing [guidelines are covered here](.github/how_to_contribute.md).
 | Terraform | >= 1.3.0 |
 | Huaweicloud Provider | >= 1.73.0 |
 
+## Modules
+
+No module.
+
 ## Resources
 
-No resources
+No resource.
 
 ## Inputs
 
-No inputs
+No input
 
 ## Outputs
 
-No outputs
+No output

Diff for: examples/cross-region-connect/README.md

@@ -38,7 +38,7 @@ Run `terraform destroy` when you don't need these resources.
 
 ## Resources
 
-No resources.
+No resource.
 
 ## Inputs
 
@@ -70,4 +70,4 @@ No resources.
 
 ## Outputs
 
-No outputs.
+No output.

Diff for: examples/simple-gateway/README.md

@@ -32,7 +32,7 @@ Run `terraform destroy` when you don't need these resources.
 
 ## Resources
 
-No resources.
+No resource.
 
 ## Inputs
 

Diff for: modules/vpn-connection/README.md

@@ -32,6 +32,10 @@ Full contributing [guidelines are covered here](../../github/how_to_contribute.m
 | Terraform | >= 1.3.0 |
 | Huaweicloud Provider | >= 1.73.0 |
 
+## Modules
+
+No module.
+
 ## Resources
 
 | Name | Type |

Diff for: modules/vpn-customer-gateway/README.md

@@ -32,6 +32,10 @@ Full contributing [guidelines are covered here](../../github/how_to_contribute.m
 | Terraform | >= 1.3.0 |
 | Huaweicloud Provider | >= 1.73.0 |
 
+## Modules
+
+No module.
+
 ## Resources
 
 | Name | Type |

Diff for: modules/vpn-gateway/README.md

@@ -32,6 +32,10 @@ Full contributing [guidelines are covered here](../../github/how_to_contribute.m
 | Terraform | >= 1.3.0 |
 | Huaweicloud Provider | >= 1.73.0 |
 
+## Modules
+
+No module.
+
 ## Resources
 
 | Name | Type |