update docs

Author: lechnerc77

sample-setup/modules/sap-btp-naming-conventions/README.md

@@ -1,3 +1,56 @@
 # SAP BTP - Naming module
 
 This module encapsulates the naming conventions for SAP BTP accounts and the labels that can be attached to some resources on SAP BTP.
+
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.11 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_random"></a> [random](#provider\_random) | n/a |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [random_uuid.self](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/uuid) | resource |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_add_managed_by_label"></a> [add\_managed\_by\_label](#input\_add\_managed\_by\_label) | Add label that resource is managed by Terraform | `bool` | `true` | no |
+| <a name="input_business_unit"></a> [business\_unit](#input\_business\_unit) | Business unit of the project e.g., HR, IT or Sales | `string` | n/a | yes |
+| <a name="input_company_name"></a> [company\_name](#input\_company\_name) | Company name to be used for subaccount subdomains. The parameter is optional<br/>Default value: `null`. | `string` | `null` | no |
+| <a name="input_costcenter"></a> [costcenter](#input\_costcenter) | Cost center to be used for subaccounts | `string` | n/a | yes |
+| <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | Delimiter to be used for namings | `string` | `"-"` | no |
+| <a name="input_directory_contacts"></a> [directory\_contacts](#input\_directory\_contacts) | Contact persons to be used for directories, added as label | `list(string)` | n/a | yes |
+| <a name="input_label_name_case"></a> [label\_name\_case](#input\_label\_name\_case) | Controls the letter case of the `label` names for labels generated by this module.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`. | `string` | `"title"` | no |
+| <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of the `label` values for labels generated by this module.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Default value: `lower`. | `string` | `"lower"` | no |
+| <a name="input_management_tool"></a> [management\_tool](#input\_management\_tool) | Defines which tool is used for management of infrastructure.<br/>Possible values: `Terraform`, `OpenTofu`.<br/>Default value: `Terraform`. | `string` | `"Terraform"` | no |
+| <a name="input_region"></a> [region](#input\_region) | The geographical region for a directory. The parameter is optional<br/>If you set it the possible values are: `EMEA`, `APAC`, `AMER`.<br/>Default value: `null`. | `string` | `null` | no |
+| <a name="input_stage"></a> [stage](#input\_stage) | Stage of the environment to be setup up.<br/>Possible values: `Dev`, `Test`, `Prod`. | `string` | n/a | yes |
+| <a name="input_subaccount_contacts"></a> [subaccount\_contacts](#input\_subaccount\_contacts) | Contact persons to be used for subaccounts, added as label | `list(string)` | n/a | yes |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_cloudfoundry_org_name"></a> [cloudfoundry\_org\_name](#output\_cloudfoundry\_org\_name) | Name of the Cloud Foundry org |
+| <a name="output_directory_description"></a> [directory\_description](#output\_directory\_description) | Description of the directory |
+| <a name="output_directory_labels"></a> [directory\_labels](#output\_directory\_labels) | Labels for the directory |
+| <a name="output_directory_name"></a> [directory\_name](#output\_directory\_name) | Name of the directory |
+| <a name="output_subaccount_description"></a> [subaccount\_description](#output\_subaccount\_description) | Description of the subaccount |
+| <a name="output_subaccount_labels"></a> [subaccount\_labels](#output\_subaccount\_labels) | Labels for the subaccount |
+| <a name="output_subaccount_name"></a> [subaccount\_name](#output\_subaccount\_name) | Name of the subaccount |
+| <a name="output_subaccount_subdomain"></a> [subaccount\_subdomain](#output\_subaccount\_subdomain) | Subdomain of the subaccount |
+| <a name="output_subaccount_usage"></a> [subaccount\_usage](#output\_subaccount\_usage) | Usage of the subaccount |