diff --git a/.terraform-docs.yaml b/.terraform-docs.yaml
index 7fb1fc1..7fd85c3 100644
--- a/.terraform-docs.yaml
+++ b/.terraform-docs.yaml
@@ -1,7 +1,7 @@
-formatter: markdown
+formatter: markdown document
settings:
- anchor: false
+ hide-empty: true
lockfile: false
output:
@@ -14,8 +14,10 @@ sort:
content: |-
## Usage
+ {{ include "examples/usage/main.md" }}
+
```hcl
- {{ include "examples/main/usage.tf" }}
+ {{ include "examples/usage/main.tf" }}
```
{{ .Providers }}
diff --git a/README.md b/README.md
index 6ccbbed..8b37500 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,22 @@
+
+
+> [!NOTE]
+> This repository is publicly accessible as part of our open-source initiative. We welcome contributions from the community alongside our organization's primary development efforts.
+
+---
+
# terraform-azurerm-helloworld
+[](CHANGELOG.md)
+[](CHANGELOG.md)
+
Terraform "Hello World!" Module
## Usage
+This example demonstrates the usage of this Terraform module with default settings.
+
```hcl
module "helloworld" {
source = "cloudeteer/helloworld/azurerm"
@@ -13,28 +25,43 @@ module "helloworld" {
## Providers
-| Name | Version |
-|------|---------|
-| azurerm | ~> 3.0 |
+The following providers are used by this module:
+
+- [azurerm](#provider\_azurerm) (~> 4.0)
-## Modules
-No modules.
## Resources
-| Name | Type |
-|------|------|
-| [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) | data source |
+The following resources are used by this module:
+
+- [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) (data source)
-## Inputs
-No inputs.
## Outputs
-| Name | Description |
-|------|-------------|
-| client\_id | n/a |
-| hello\_world | n/a |
-
\ No newline at end of file
+The following outputs are exported:
+
+### [client\_id](#output\_client\_id)
+
+Description: n/a
+
+### [hello\_world](#output\_hello\_world)
+
+Description: n/a
+
+
+## Contributions
+
+We welcome all kinds of contributions, whether it's reporting bugs, submitting feature requests, or directly contributing to the development. Please read our [Contributing Guidelines](CONTRIBUTING.md) to learn how you can best contribute.
+
+Thank you for your interest and support!
+
+## Copyright and license
+
+
+
+© 2024 CLOUDETEER GmbH
+
+This project is licensed under the [MIT License](LICENSE).
diff --git a/examples/usage/main.md b/examples/usage/main.md
new file mode 100644
index 0000000..0dd0977
--- /dev/null
+++ b/examples/usage/main.md
@@ -0,0 +1 @@
+This example demonstrates the usage of this Terraform module with default settings.
diff --git a/examples/main/usage.tf b/examples/usage/main.tf
similarity index 100%
rename from examples/main/usage.tf
rename to examples/usage/main.tf
diff --git a/main.tf b/main.tf
index 79533f0..234d7f4 100644
--- a/main.tf
+++ b/main.tf
@@ -4,7 +4,7 @@ terraform {
required_providers {
azurerm = {
source = "hashicorp/azurerm"
- version = "~> 3.0"
+ version = "~> 4.0"
}
}
}