Please find the examples here
This README section is automatically generated using terraform-docs a powerful documentation generator for Terraform modules.
It parses your module’s variables, outputs, providers, and resources to produce consistent and up-to-date Markdown documentation directly inside your README file.
Execute below to generate latest docs
terraform-docs markdown table --output-file README.md --output-mode inject .