From dafa2e84f76f6d79c8afd956ec0b2df500f29245 Mon Sep 17 00:00:00 2001 From: Martyn Ranyard Date: Mon, 10 Feb 2020 19:57:22 +0100 Subject: [PATCH] Link formats documentation in README (#181) Co-authored-by: Khosrow Moossavi --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3873d48..d4da269 100644 --- a/README.md +++ b/README.md @@ -81,25 +81,25 @@ Show help information: terraform-docs --help ``` -Generate JSON from the Terraform configuration in folder `./examples`: +Generate [JSON](docs/formats/json.md) from the Terraform configuration in folder `./examples`: ```bash terraform-docs json ./examples ``` -Generate YAML from the Terraform configuration in folder `./examples`: +Generate [YAML](docs/formats/yaml.md) from the Terraform configuration in folder `./examples`: ```bash terraform-docs yaml ./examples ``` -Generate Markdown tables from the Terraform configuration in folder `./examples`: +Generate [Markdown tables](docs/formats/markdown-table.md) from the Terraform configuration in folder `./examples`: ```bash terraform-docs markdown table ./examples ``` -Generate a Markdown document from the Terraform configuration in folder `./examples`: +Generate a [Markdown document](docs/formats/markdown-document.md) from the Terraform configuration in folder `./examples`: ```bash terraform-docs markdown document ./examples